datadog_api_client 2.17.0 → 2.19.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.apigentools-info +4 -4
- data/.generator/conftest.py +1 -1
- data/.generator/poetry.lock +69 -69
- data/.generator/schemas/v1/openapi.yaml +334 -16
- data/.generator/schemas/v2/openapi.yaml +2864 -470
- data/.generator/src/generator/cli.py +5 -0
- data/.generator/src/generator/templates/datadog_api_client.j2 +19 -0
- data/.generator/src/generator/templates/model_generic.j2 +2 -2
- data/.pre-commit-config.yaml +1 -1
- data/CHANGELOG.md +43 -0
- data/examples/v1/aws-integration/CreateAWSAccount.rb +2 -2
- data/examples/v1/aws-integration/DeleteAWSAccount.rb +1 -1
- data/examples/v1/aws-integration/UpdateAWSAccount.rb +6 -6
- data/examples/v1/azure-integration/CreateAzureIntegration.rb +5 -4
- data/examples/v1/azure-integration/DeleteAzureIntegration.rb +2 -14
- data/examples/v1/azure-integration/UpdateAzureHostFilters.rb +1 -0
- data/examples/v1/azure-integration/UpdateAzureIntegration.rb +5 -4
- data/examples/v1/dashboards/CreateDashboard_1284514532.rb +3 -0
- data/examples/v1/gcp-integration/CreateGCPIntegration.rb +4 -5
- data/examples/v1/gcp-integration/DeleteGCPIntegration.rb +2 -14
- data/examples/v1/gcp-integration/UpdateGCPIntegration.rb +4 -5
- data/examples/v1/service-level-objectives/CreateSLO_3765703239.rb +46 -0
- data/examples/v1/synthetics/PatchTest.rb +22 -0
- data/examples/v2/ci-visibility-pipelines/CreateCIAppPipelineEvent.rb +0 -3
- data/examples/v2/ci-visibility-pipelines/CreateCIAppPipelineEvent_129899466.rb +0 -3
- data/examples/v2/cloud-cost-management/CreateCostAWSCURConfig.rb +18 -0
- data/examples/v2/cloud-cost-management/CreateCostAzureUCConfigs.rb +29 -0
- data/examples/v2/cloud-cost-management/DeleteCostAWSCURConfig.rb +5 -0
- data/examples/v2/cloud-cost-management/DeleteCostAzureUCConfig.rb +5 -0
- data/examples/v2/cloud-cost-management/GetCloudCostActivity.rb +5 -0
- data/examples/v2/cloud-cost-management/ListAWSRelatedAccounts.rb +5 -0
- data/examples/v2/cloud-cost-management/ListCostAWSCURConfigs.rb +5 -0
- data/examples/v2/cloud-cost-management/ListCostAzureUCConfigs.rb +5 -0
- data/examples/v2/cloud-cost-management/UpdateCostAWSCURConfig.rb +14 -0
- data/examples/v2/cloud-cost-management/UpdateCostAzureUCConfigs.rb +14 -0
- data/examples/v2/cloudflare-integration/CreateCloudflareAccount.rb +1 -1
- data/examples/v2/cloudflare-integration/UpdateCloudflareAccount.rb +4 -1
- data/examples/v2/container-images/ListContainerImages.rb +0 -3
- data/examples/v2/container-images/ListContainerImages_3088586393.rb +0 -3
- data/examples/v2/container-images/ListContainerImages_3974828736.rb +0 -3
- data/examples/v2/containers/ListContainers.rb +0 -3
- data/examples/v2/containers/ListContainers_2175733917.rb +0 -3
- data/examples/v2/containers/ListContainers_931009654.rb +0 -3
- data/examples/v2/dora-metrics/CreateDORADeployment.rb +23 -0
- data/examples/v2/dora-metrics/CreateDORAIncident.rb +25 -0
- data/examples/v2/downtimes/ListMonitorDowntimes_3316718253.rb +5 -0
- data/examples/v2/events/ListEvents.rb +0 -3
- data/examples/v2/events/ListEvents_1527584014.rb +0 -3
- data/examples/v2/events/ListEvents_2663715109.rb +0 -3
- data/examples/v2/events/SearchEvents.rb +0 -3
- data/examples/v2/events/SearchEvents_3856995058.rb +0 -3
- data/examples/v2/gcp-integration/CreateGCPSTSAccount_130557025.rb +16 -0
- data/examples/v2/gcp-integration/CreateGCPSTSAccount_2597004741.rb +16 -0
- data/examples/v2/gcp-integration/CreateGCPSTSAccount_4235664992.rb +17 -0
- data/examples/v2/gcp-integration/UpdateGCPSTSAccount_3205636354.rb +19 -0
- data/examples/v2/okta-integration/CreateOktaAccount.rb +19 -0
- data/examples/v2/okta-integration/DeleteOktaAccount.rb +5 -0
- data/examples/v2/okta-integration/GetOktaAccount.rb +8 -0
- data/examples/v2/okta-integration/ListOktaAccounts.rb +5 -0
- data/examples/v2/okta-integration/UpdateOktaAccount.rb +20 -0
- data/examples/v2/security-monitoring/CreateSecurityMonitoringRule_3367706049.rb +46 -0
- data/examples/v2/sensitive-data-scanner/CreateScanningRule.rb +7 -0
- data/examples/v2/sensitive-data-scanner/UpdateScanningRule.rb +7 -10
- data/examples/v2/teams/CreateTeamMembership.rb +6 -0
- data/examples/v2/usage-metering/GetActiveBillingDimensions.rb +8 -0
- data/examples/v2/usage-metering/GetMonthlyCostAttribution.rb +8 -0
- data/examples/v2/usage-metering/GetProjectedCost.rb +8 -0
- data/lib/datadog_api_client/configuration.rb +4 -5
- data/lib/datadog_api_client/inflector.rb +113 -0
- data/lib/datadog_api_client/v1/api/downtimes_api.rb +28 -7
- data/lib/datadog_api_client/v1/api/hosts_api.rb +1 -1
- data/lib/datadog_api_client/v1/api/monitors_api.rb +1 -1
- data/lib/datadog_api_client/v1/api/synthetics_api.rb +73 -1
- data/lib/datadog_api_client/v1/models/azure_account.rb +13 -2
- data/lib/datadog_api_client/v1/models/gcp_account.rb +22 -2
- data/lib/datadog_api_client/v1/models/organization.rb +1 -1
- data/lib/datadog_api_client/v1/models/service_level_objective.rb +11 -1
- data/lib/datadog_api_client/v1/models/service_level_objective_request.rb +11 -1
- data/lib/datadog_api_client/v1/models/slo_data_source_query_definition.rb +62 -0
- data/lib/datadog_api_client/v1/models/slo_formula.rb +98 -0
- data/lib/datadog_api_client/v1/models/slo_response_data.rb +11 -1
- data/lib/datadog_api_client/v1/models/slo_sli_spec.rb +62 -0
- data/lib/datadog_api_client/v1/models/slo_time_slice_comparator.rb +29 -0
- data/lib/datadog_api_client/v1/models/slo_time_slice_condition.rb +141 -0
- data/lib/datadog_api_client/v1/models/slo_time_slice_query.rb +131 -0
- data/lib/datadog_api_client/v1/models/slo_time_slice_spec.rb +99 -0
- data/lib/datadog_api_client/v1/models/slo_type.rb +1 -0
- data/lib/datadog_api_client/v1/models/slo_type_numeric.rb +1 -0
- data/lib/datadog_api_client/v1/models/synthetics_patch_test_body.rb +82 -0
- data/lib/datadog_api_client/v1/models/synthetics_patch_test_operation.rb +100 -0
- data/lib/datadog_api_client/v1/models/synthetics_patch_test_operation_name.rb +31 -0
- data/lib/datadog_api_client/v1/models/usage_summary_date.rb +11 -1
- data/lib/datadog_api_client/v1/models/usage_summary_date_org.rb +31 -1
- data/lib/datadog_api_client/v1/models/usage_summary_response.rb +31 -1
- data/lib/datadog_api_client/v1/models/widget_live_span.rb +2 -0
- data/lib/datadog_api_client/v2/api/ci_visibility_pipelines_api.rb +0 -6
- data/lib/datadog_api_client/v2/api/cloud_cost_management_api.rb +680 -0
- data/lib/datadog_api_client/v2/api/container_images_api.rb +0 -6
- data/lib/datadog_api_client/v2/api/containers_api.rb +0 -6
- data/lib/datadog_api_client/v2/api/dora_metrics_api.rb +181 -0
- data/lib/datadog_api_client/v2/api/downtimes_api.rb +25 -0
- data/lib/datadog_api_client/v2/api/events_api.rb +0 -12
- data/lib/datadog_api_client/v2/api/metrics_api.rb +3 -2
- data/lib/datadog_api_client/v2/api/okta_integration_api.rb +355 -0
- data/lib/datadog_api_client/v2/api/usage_metering_api.rb +241 -0
- data/lib/datadog_api_client/v2/models/active_billing_dimensions_attributes.rb +92 -0
- data/lib/datadog_api_client/v2/models/active_billing_dimensions_body.rb +100 -0
- data/lib/datadog_api_client/v2/models/active_billing_dimensions_response.rb +80 -0
- data/lib/datadog_api_client/v2/models/active_billing_dimensions_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/api_keys_response.rb +14 -4
- data/lib/datadog_api_client/v2/models/api_keys_response_meta.rb +90 -0
- data/lib/datadog_api_client/v2/models/api_keys_response_meta_page.rb +80 -0
- data/lib/datadog_api_client/v2/models/application_key_response_meta.rb +90 -0
- data/lib/datadog_api_client/v2/models/application_key_response_meta_page.rb +80 -0
- data/lib/datadog_api_client/v2/models/aws_cur_config.rb +129 -0
- data/lib/datadog_api_client/v2/models/aws_cur_config_attributes.rb +305 -0
- data/lib/datadog_api_client/v2/models/aws_cur_config_patch_data.rb +119 -0
- data/lib/datadog_api_client/v2/models/aws_cur_config_patch_request.rb +98 -0
- data/lib/datadog_api_client/v2/models/aws_cur_config_patch_request_attributes.rb +98 -0
- data/lib/datadog_api_client/v2/models/aws_cur_config_patch_request_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/aws_cur_config_post_data.rb +119 -0
- data/lib/datadog_api_client/v2/models/aws_cur_config_post_request.rb +98 -0
- data/lib/datadog_api_client/v2/models/aws_cur_config_post_request_attributes.rb +202 -0
- data/lib/datadog_api_client/v2/models/aws_cur_config_post_request_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/aws_cur_config_response.rb +80 -0
- data/lib/datadog_api_client/v2/models/aws_cur_config_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/aws_cur_configs_response.rb +82 -0
- data/lib/datadog_api_client/v2/models/aws_related_account.rb +129 -0
- data/lib/datadog_api_client/v2/models/aws_related_account_attributes.rb +90 -0
- data/lib/datadog_api_client/v2/models/aws_related_account_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/aws_related_accounts_response.rb +82 -0
- data/lib/datadog_api_client/v2/models/azure_uc_config.rb +378 -0
- data/lib/datadog_api_client/v2/models/azure_uc_config_pair.rb +129 -0
- data/lib/datadog_api_client/v2/models/azure_uc_config_pair_attributes.rb +110 -0
- data/lib/datadog_api_client/v2/models/azure_uc_config_pair_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/azure_uc_config_pairs_response.rb +80 -0
- data/lib/datadog_api_client/v2/models/azure_uc_config_patch_data.rb +119 -0
- data/lib/datadog_api_client/v2/models/azure_uc_config_patch_request.rb +98 -0
- data/lib/datadog_api_client/v2/models/azure_uc_config_patch_request_attributes.rb +98 -0
- data/lib/datadog_api_client/v2/models/azure_uc_config_patch_request_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/azure_uc_config_post_data.rb +119 -0
- data/lib/datadog_api_client/v2/models/azure_uc_config_post_request.rb +98 -0
- data/lib/datadog_api_client/v2/models/azure_uc_config_post_request_attributes.rb +192 -0
- data/lib/datadog_api_client/v2/models/azure_uc_config_post_request_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/azure_uc_configs_response.rb +82 -0
- data/lib/datadog_api_client/v2/models/bill_config.rb +161 -0
- data/lib/datadog_api_client/v2/models/ci_app_git_info.rb +2 -2
- data/lib/datadog_api_client/v2/models/cloud_cost_activity.rb +119 -0
- data/lib/datadog_api_client/v2/models/cloud_cost_activity_attributes.rb +98 -0
- data/lib/datadog_api_client/v2/models/cloud_cost_activity_response.rb +80 -0
- data/lib/datadog_api_client/v2/models/cloud_cost_activity_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_rule_attributes.rb +13 -1
- data/lib/datadog_api_client/v2/models/cloudflare_account_create_request_attributes.rb +28 -4
- data/lib/datadog_api_client/v2/models/cloudflare_account_response_attributes.rb +28 -4
- data/lib/datadog_api_client/v2/models/cloudflare_account_update_request_attributes.rb +28 -4
- data/lib/datadog_api_client/v2/models/cost_attribution_aggregates_body.rb +100 -0
- data/lib/datadog_api_client/v2/models/cost_attribution_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/dora_deployment_request.rb +98 -0
- data/lib/datadog_api_client/v2/models/dora_deployment_request_attributes.rb +170 -0
- data/lib/datadog_api_client/v2/models/dora_deployment_request_data.rb +98 -0
- data/lib/datadog_api_client/v2/models/dora_deployment_response.rb +98 -0
- data/lib/datadog_api_client/v2/models/dora_deployment_response_data.rb +108 -0
- data/lib/datadog_api_client/v2/models/dora_deployment_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/dora_git_info.rb +125 -0
- data/lib/datadog_api_client/v2/models/dora_incident_request.rb +98 -0
- data/lib/datadog_api_client/v2/models/dora_incident_request_attributes.rb +179 -0
- data/lib/datadog_api_client/v2/models/dora_incident_request_data.rb +98 -0
- data/lib/datadog_api_client/v2/models/dora_incident_response.rb +98 -0
- data/lib/datadog_api_client/v2/models/dora_incident_response_data.rb +108 -0
- data/lib/datadog_api_client/v2/models/dora_incident_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/full_api_key_attributes.rb +24 -4
- data/lib/datadog_api_client/v2/models/gcpsts_service_account_attributes.rb +25 -5
- data/lib/datadog_api_client/v2/models/incident_attachment_link_attributes.rb +14 -4
- data/lib/datadog_api_client/v2/models/incident_create_relationships.rb +9 -19
- data/lib/datadog_api_client/v2/models/incident_impacts_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/incident_integration_metadata_attributes.rb +21 -1
- data/lib/datadog_api_client/v2/models/incident_integration_metadata_response_data.rb +11 -1
- data/lib/datadog_api_client/v2/models/incident_integration_relationships.rb +90 -0
- data/lib/datadog_api_client/v2/models/incident_non_datadog_creator.rb +90 -0
- data/lib/datadog_api_client/v2/models/incident_responders_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/incident_response_attributes.rb +69 -4
- data/lib/datadog_api_client/v2/models/incident_response_relationships.rb +42 -4
- data/lib/datadog_api_client/v2/models/incident_severity.rb +31 -0
- data/lib/datadog_api_client/v2/models/incident_todo_attributes.rb +24 -4
- data/lib/datadog_api_client/v2/models/incident_todo_relationships.rb +90 -0
- data/lib/datadog_api_client/v2/models/incident_todo_response_data.rb +11 -1
- data/lib/datadog_api_client/v2/models/incident_update_relationships.rb +8 -0
- data/lib/datadog_api_client/v2/models/incident_user_defined_field_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/list_application_keys_response.rb +14 -4
- data/lib/datadog_api_client/v2/models/monthly_cost_attribution_attributes.rb +151 -0
- data/lib/datadog_api_client/v2/models/monthly_cost_attribution_body.rb +100 -0
- data/lib/datadog_api_client/v2/models/monthly_cost_attribution_meta.rb +92 -0
- data/lib/datadog_api_client/v2/models/monthly_cost_attribution_pagination.rb +88 -0
- data/lib/datadog_api_client/v2/models/monthly_cost_attribution_response.rb +92 -0
- data/lib/datadog_api_client/v2/models/okta_account.rb +129 -0
- data/lib/datadog_api_client/v2/models/okta_account_attributes.rb +170 -0
- data/lib/datadog_api_client/v2/models/okta_account_request.rb +98 -0
- data/lib/datadog_api_client/v2/models/okta_account_response.rb +80 -0
- data/lib/datadog_api_client/v2/models/okta_account_response_data.rb +140 -0
- data/lib/datadog_api_client/v2/models/okta_account_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/okta_account_update_request.rb +98 -0
- data/lib/datadog_api_client/v2/models/okta_account_update_request_attributes.rb +149 -0
- data/lib/datadog_api_client/v2/models/okta_account_update_request_data.rb +90 -0
- data/lib/datadog_api_client/v2/models/okta_accounts_response.rb +82 -0
- data/lib/datadog_api_client/v2/models/partial_api_key_attributes.rb +24 -4
- data/lib/datadog_api_client/v2/models/powerpack_relationships.rb +2 -2
- data/lib/datadog_api_client/v2/models/powerpacks_response_meta_pagination.rb +8 -0
- data/lib/datadog_api_client/v2/models/projected_cost.rb +100 -0
- data/lib/datadog_api_client/v2/models/projected_cost_attributes.rb +132 -0
- data/lib/datadog_api_client/v2/models/projected_cost_response.rb +82 -0
- data/lib/datadog_api_client/v2/models/projected_cost_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/relationship_to_incident_impact_data.rb +119 -0
- data/lib/datadog_api_client/v2/models/relationship_to_incident_impacts.rb +100 -0
- data/lib/datadog_api_client/v2/models/relationship_to_incident_responder_data.rb +119 -0
- data/lib/datadog_api_client/v2/models/relationship_to_incident_responders.rb +100 -0
- data/lib/datadog_api_client/v2/models/relationship_to_incident_user_defined_field_data.rb +119 -0
- data/lib/datadog_api_client/v2/models/relationship_to_incident_user_defined_fields.rb +100 -0
- data/lib/datadog_api_client/v2/models/relationship_to_user_team_team.rb +98 -0
- data/lib/datadog_api_client/v2/models/relationship_to_user_team_team_data.rb +119 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_options.rb +14 -4
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_third_party_options.rb +114 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_type_create.rb +1 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_update_payload.rb +13 -1
- data/lib/datadog_api_client/v2/models/security_monitoring_standard_rule_create_payload.rb +13 -1
- data/lib/datadog_api_client/v2/models/security_monitoring_standard_rule_response.rb +13 -1
- data/lib/datadog_api_client/v2/models/security_monitoring_third_party_root_query.rb +92 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_third_party_rule_case.rb +112 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_third_party_rule_case_create.rb +130 -0
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_included_keyword_configuration.rb +134 -0
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_rule_attributes.rb +46 -1
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_standard_pattern_attributes.rb +45 -1
- data/lib/datadog_api_client/v2/models/sort_direction.rb +27 -0
- data/lib/datadog_api_client/v2/models/user_team_attributes.rb +24 -1
- data/lib/datadog_api_client/v2/models/user_team_relationships.rb +11 -1
- data/lib/datadog_api_client/v2/models/user_team_team_type.rb +26 -0
- data/lib/datadog_api_client/version.rb +1 -1
- data/lib/datadog_api_client.rb +16 -1
- metadata +144 -2
@@ -151,6 +151,13 @@ components:
|
|
151
151
|
required: true
|
152
152
|
schema:
|
153
153
|
type: string
|
154
|
+
CloudAccountID:
|
155
|
+
description: Cloud Account id.
|
156
|
+
in: path
|
157
|
+
name: cloud_account_id
|
158
|
+
required: true
|
159
|
+
schema:
|
160
|
+
type: string
|
154
161
|
CloudWorkloadSecurityAgentRuleID:
|
155
162
|
description: The ID of the Agent rule.
|
156
163
|
example: 3b5-v82-ns6
|
@@ -689,6 +696,26 @@ components:
|
|
689
696
|
items:
|
690
697
|
$ref: '#/components/schemas/APIKeyResponseIncludedItem'
|
691
698
|
type: array
|
699
|
+
meta:
|
700
|
+
$ref: '#/components/schemas/APIKeysResponseMeta'
|
701
|
+
type: object
|
702
|
+
APIKeysResponseMeta:
|
703
|
+
description: Additional information related to api keys response.
|
704
|
+
properties:
|
705
|
+
max_allowed:
|
706
|
+
description: Max allowed number of API keys.
|
707
|
+
format: int64
|
708
|
+
type: integer
|
709
|
+
page:
|
710
|
+
$ref: '#/components/schemas/APIKeysResponseMetaPage'
|
711
|
+
type: object
|
712
|
+
APIKeysResponseMetaPage:
|
713
|
+
description: Additional information related to the API keys response.
|
714
|
+
properties:
|
715
|
+
total_filtered_count:
|
716
|
+
description: Total filtered application key count.
|
717
|
+
format: int64
|
718
|
+
type: integer
|
692
719
|
type: object
|
693
720
|
APIKeysSort:
|
694
721
|
default: name
|
@@ -721,6 +748,90 @@ components:
|
|
721
748
|
type: string
|
722
749
|
x-enum-varnames:
|
723
750
|
- API_KEYS
|
751
|
+
AWSRelatedAccount:
|
752
|
+
description: AWS related account.
|
753
|
+
properties:
|
754
|
+
attributes:
|
755
|
+
$ref: '#/components/schemas/AWSRelatedAccountAttributes'
|
756
|
+
id:
|
757
|
+
description: The AWS account ID.
|
758
|
+
example: '123456789123'
|
759
|
+
type: string
|
760
|
+
type:
|
761
|
+
$ref: '#/components/schemas/AWSRelatedAccountType'
|
762
|
+
required:
|
763
|
+
- id
|
764
|
+
- type
|
765
|
+
type: object
|
766
|
+
AWSRelatedAccountAttributes:
|
767
|
+
description: Attributes for an AWS related account.
|
768
|
+
properties:
|
769
|
+
has_datadog_integration:
|
770
|
+
description: Whether or not the AWS account has a Datadog integration.
|
771
|
+
type: boolean
|
772
|
+
name:
|
773
|
+
description: The name of the AWS account.
|
774
|
+
type: string
|
775
|
+
type: object
|
776
|
+
AWSRelatedAccountType:
|
777
|
+
default: aws_account
|
778
|
+
description: Type of AWS related account.
|
779
|
+
enum:
|
780
|
+
- aws_account
|
781
|
+
example: aws_account
|
782
|
+
type: string
|
783
|
+
x-enum-varnames:
|
784
|
+
- AWS_ACCOUNT
|
785
|
+
AWSRelatedAccountsResponse:
|
786
|
+
description: List of AWS related accounts.
|
787
|
+
properties:
|
788
|
+
data:
|
789
|
+
description: An AWS related account.
|
790
|
+
items:
|
791
|
+
$ref: '#/components/schemas/AWSRelatedAccount'
|
792
|
+
type: array
|
793
|
+
type: object
|
794
|
+
ActiveBillingDimensionsAttributes:
|
795
|
+
description: List of active billing dimensions.
|
796
|
+
properties:
|
797
|
+
month:
|
798
|
+
description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`.'
|
799
|
+
format: date-time
|
800
|
+
type: string
|
801
|
+
values:
|
802
|
+
description: 'List of active billing dimensions. Example: `[infra_host,
|
803
|
+
apm_host, serverless_infra]`.'
|
804
|
+
items:
|
805
|
+
description: A given billing dimension in a list.
|
806
|
+
example: infra_host
|
807
|
+
type: string
|
808
|
+
type: array
|
809
|
+
type: object
|
810
|
+
ActiveBillingDimensionsBody:
|
811
|
+
description: Active billing dimensions data.
|
812
|
+
properties:
|
813
|
+
attributes:
|
814
|
+
$ref: '#/components/schemas/ActiveBillingDimensionsAttributes'
|
815
|
+
id:
|
816
|
+
description: Unique ID of the response.
|
817
|
+
type: string
|
818
|
+
type:
|
819
|
+
$ref: '#/components/schemas/ActiveBillingDimensionsType'
|
820
|
+
type: object
|
821
|
+
ActiveBillingDimensionsResponse:
|
822
|
+
description: Active billing dimensions response.
|
823
|
+
properties:
|
824
|
+
data:
|
825
|
+
$ref: '#/components/schemas/ActiveBillingDimensionsBody'
|
826
|
+
type: object
|
827
|
+
ActiveBillingDimensionsType:
|
828
|
+
default: billing_dimensions
|
829
|
+
description: Type of active billing dimensions data.
|
830
|
+
enum:
|
831
|
+
- billing_dimensions
|
832
|
+
type: string
|
833
|
+
x-enum-varnames:
|
834
|
+
- BILLING_DIMENSIONS
|
724
835
|
ApmRetentionFilterType:
|
725
836
|
default: apm_retention_filter
|
726
837
|
description: The type of the resource.
|
@@ -792,6 +903,24 @@ components:
|
|
792
903
|
oneOf:
|
793
904
|
- $ref: '#/components/schemas/User'
|
794
905
|
- $ref: '#/components/schemas/Role'
|
906
|
+
ApplicationKeyResponseMeta:
|
907
|
+
description: Additional information related to the application key response.
|
908
|
+
properties:
|
909
|
+
max_allowed_per_user:
|
910
|
+
description: Max allowed number of application keys per user.
|
911
|
+
format: int64
|
912
|
+
type: integer
|
913
|
+
page:
|
914
|
+
$ref: '#/components/schemas/ApplicationKeyResponseMetaPage'
|
915
|
+
type: object
|
916
|
+
ApplicationKeyResponseMetaPage:
|
917
|
+
description: Additional information related to the application key response.
|
918
|
+
properties:
|
919
|
+
total_filtered_count:
|
920
|
+
description: Total filtered application key count.
|
921
|
+
format: int64
|
922
|
+
type: integer
|
923
|
+
type: object
|
795
924
|
ApplicationKeyUpdateAttributes:
|
796
925
|
description: Attributes used to update an application Key.
|
797
926
|
properties:
|
@@ -1290,171 +1419,624 @@ components:
|
|
1290
1419
|
type: string
|
1291
1420
|
x-enum-varnames:
|
1292
1421
|
- AUTHN_MAPPINGS
|
1293
|
-
|
1294
|
-
description:
|
1422
|
+
AwsCURConfig:
|
1423
|
+
description: AWS CUR config.
|
1295
1424
|
properties:
|
1296
|
-
|
1297
|
-
$ref: '#/components/schemas/
|
1425
|
+
attributes:
|
1426
|
+
$ref: '#/components/schemas/AwsCURConfigAttributes'
|
1427
|
+
id:
|
1428
|
+
description: The ID of the AWS CUR config.
|
1429
|
+
format: int64
|
1430
|
+
type: integer
|
1431
|
+
type:
|
1432
|
+
$ref: '#/components/schemas/AwsCURConfigType'
|
1298
1433
|
required:
|
1299
|
-
-
|
1434
|
+
- attributes
|
1435
|
+
- type
|
1300
1436
|
type: object
|
1301
|
-
|
1302
|
-
|
1303
|
-
description: The mute properties to be updated.
|
1437
|
+
AwsCURConfigAttributes:
|
1438
|
+
description: Attributes for An AWS CUR config.
|
1304
1439
|
properties:
|
1305
|
-
|
1306
|
-
|
1440
|
+
account_id:
|
1441
|
+
description: The AWS account ID.
|
1442
|
+
example: '123456789123'
|
1443
|
+
type: string
|
1444
|
+
bucket_name:
|
1445
|
+
description: The AWS bucket name used to store the Cost and Usage Report.
|
1446
|
+
example: dd-cost-bucket
|
1447
|
+
type: string
|
1448
|
+
bucket_region:
|
1449
|
+
description: The region the bucket is located in.
|
1450
|
+
example: us-east-1
|
1451
|
+
type: string
|
1452
|
+
created_at:
|
1453
|
+
description: The timestamp when the AWS CUR config was created.
|
1454
|
+
pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{6}$
|
1455
|
+
type: string
|
1456
|
+
error_messages:
|
1457
|
+
description: The error messages for the AWS CUR config.
|
1458
|
+
items:
|
1459
|
+
type: string
|
1460
|
+
type: array
|
1461
|
+
months:
|
1462
|
+
deprecated: true
|
1463
|
+
description: The number of months the report has been backfilled.
|
1464
|
+
format: int32
|
1465
|
+
maximum: 36
|
1466
|
+
type: integer
|
1467
|
+
report_name:
|
1468
|
+
description: The name of the Cost and Usage Report.
|
1469
|
+
example: dd-report-name
|
1470
|
+
type: string
|
1471
|
+
report_prefix:
|
1472
|
+
description: The report prefix used for the Cost and Usage Report.
|
1473
|
+
example: dd-report-prefix
|
1474
|
+
type: string
|
1475
|
+
status:
|
1476
|
+
description: The status of the AWS CUR.
|
1477
|
+
example: active
|
1478
|
+
type: string
|
1479
|
+
status_updated_at:
|
1480
|
+
description: The timestamp when the AWS CUR config status was updated.
|
1481
|
+
pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{6}$
|
1482
|
+
type: string
|
1483
|
+
updated_at:
|
1484
|
+
description: The timestamp when the AWS CUR config status was updated.
|
1485
|
+
pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{6}$
|
1486
|
+
type: string
|
1307
1487
|
required:
|
1308
|
-
-
|
1488
|
+
- account_id
|
1489
|
+
- bucket_name
|
1490
|
+
- bucket_region
|
1491
|
+
- report_name
|
1492
|
+
- report_prefix
|
1493
|
+
- status
|
1309
1494
|
type: object
|
1310
|
-
|
1311
|
-
description:
|
1495
|
+
AwsCURConfigPatchData:
|
1496
|
+
description: AWS CUR config Patch data.
|
1312
1497
|
properties:
|
1313
1498
|
attributes:
|
1314
|
-
$ref: '#/components/schemas/
|
1315
|
-
id:
|
1316
|
-
description: UUID to identify the request
|
1317
|
-
example: dbe5f567-192b-4404-b908-29b70e1c9f76
|
1318
|
-
type: string
|
1319
|
-
meta:
|
1320
|
-
$ref: '#/components/schemas/BulkMuteFindingsRequestMeta'
|
1499
|
+
$ref: '#/components/schemas/AwsCURConfigPatchRequestAttributes'
|
1321
1500
|
type:
|
1322
|
-
$ref: '#/components/schemas/
|
1501
|
+
$ref: '#/components/schemas/AwsCURConfigPatchRequestType'
|
1323
1502
|
required:
|
1324
|
-
- id
|
1325
|
-
- type
|
1326
1503
|
- attributes
|
1327
|
-
-
|
1328
|
-
type: object
|
1329
|
-
BulkMuteFindingsRequestMeta:
|
1330
|
-
description: Meta object containing the findings to be updated.
|
1331
|
-
properties:
|
1332
|
-
findings:
|
1333
|
-
description: Array of findings.
|
1334
|
-
items:
|
1335
|
-
$ref: '#/components/schemas/BulkMuteFindingsRequestMetaFindings'
|
1336
|
-
type: array
|
1504
|
+
- type
|
1337
1505
|
type: object
|
1338
|
-
|
1339
|
-
description:
|
1506
|
+
AwsCURConfigPatchRequest:
|
1507
|
+
description: AWS CUR config Patch Request.
|
1340
1508
|
properties:
|
1341
|
-
|
1342
|
-
$ref: '#/components/schemas/
|
1509
|
+
data:
|
1510
|
+
$ref: '#/components/schemas/AwsCURConfigPatchData'
|
1511
|
+
required:
|
1512
|
+
- data
|
1343
1513
|
type: object
|
1344
|
-
|
1345
|
-
|
1346
|
-
description: Object containing the new mute properties of the findings.
|
1514
|
+
AwsCURConfigPatchRequestAttributes:
|
1515
|
+
description: Attributes for AWS CUR config Patch Request.
|
1347
1516
|
properties:
|
1348
|
-
|
1349
|
-
description:
|
1350
|
-
are muted or unmuted. This field has a maximum limit of 280 characters.
|
1351
|
-
type: string
|
1352
|
-
expiration_date:
|
1353
|
-
description: 'The expiration date of the mute or unmute action (Unix ms).
|
1354
|
-
It must be set to a value greater than the current timestamp.
|
1355
|
-
|
1356
|
-
If this field is not provided, the finding will be muted or unmuted indefinitely,
|
1357
|
-
which is equivalent to setting the expiration date to 9999999999999.
|
1358
|
-
|
1359
|
-
'
|
1360
|
-
example: 1778721573794
|
1361
|
-
format: int64
|
1362
|
-
type: integer
|
1363
|
-
muted:
|
1364
|
-
description: Whether those findings should be muted or unmuted.
|
1517
|
+
is_enabled:
|
1518
|
+
description: Whether or not the Cloud Cost Management account is enabled.
|
1365
1519
|
example: true
|
1366
1520
|
type: boolean
|
1367
|
-
reason:
|
1368
|
-
$ref: '#/components/schemas/FindingMuteReason'
|
1369
1521
|
required:
|
1370
|
-
-
|
1371
|
-
- reason
|
1522
|
+
- is_enabled
|
1372
1523
|
type: object
|
1373
|
-
|
1374
|
-
|
1524
|
+
AwsCURConfigPatchRequestType:
|
1525
|
+
default: aws_cur_config_patch_request
|
1526
|
+
description: Type of AWS CUR config Patch Request.
|
1527
|
+
enum:
|
1528
|
+
- aws_cur_config_patch_request
|
1529
|
+
example: aws_cur_config_patch_request
|
1530
|
+
type: string
|
1531
|
+
x-enum-varnames:
|
1532
|
+
- AWS_CUR_CONFIG_PATCH_REQUEST
|
1533
|
+
AwsCURConfigPostData:
|
1534
|
+
description: AWS CUR config Post data.
|
1535
|
+
properties:
|
1536
|
+
attributes:
|
1537
|
+
$ref: '#/components/schemas/AwsCURConfigPostRequestAttributes'
|
1538
|
+
type:
|
1539
|
+
$ref: '#/components/schemas/AwsCURConfigPostRequestType'
|
1540
|
+
required:
|
1541
|
+
- attributes
|
1542
|
+
- type
|
1543
|
+
type: object
|
1544
|
+
AwsCURConfigPostRequest:
|
1545
|
+
description: AWS CUR config Post Request.
|
1375
1546
|
properties:
|
1376
1547
|
data:
|
1377
|
-
$ref: '#/components/schemas/
|
1548
|
+
$ref: '#/components/schemas/AwsCURConfigPostData'
|
1378
1549
|
required:
|
1379
1550
|
- data
|
1380
1551
|
type: object
|
1381
|
-
|
1382
|
-
description:
|
1552
|
+
AwsCURConfigPostRequestAttributes:
|
1553
|
+
description: Attributes for AWS CUR config Post Request.
|
1383
1554
|
properties:
|
1384
|
-
|
1385
|
-
description:
|
1386
|
-
example:
|
1555
|
+
account_id:
|
1556
|
+
description: The AWS account ID.
|
1557
|
+
example: '123456789123'
|
1387
1558
|
type: string
|
1388
|
-
|
1389
|
-
|
1390
|
-
|
1391
|
-
CIAppAggregateBucketValue:
|
1392
|
-
description: A bucket value, can either be a timeseries or a single value.
|
1393
|
-
oneOf:
|
1394
|
-
- $ref: '#/components/schemas/CIAppAggregateBucketValueSingleString'
|
1395
|
-
- $ref: '#/components/schemas/CIAppAggregateBucketValueSingleNumber'
|
1396
|
-
- $ref: '#/components/schemas/CIAppAggregateBucketValueTimeseries'
|
1397
|
-
CIAppAggregateBucketValueSingleNumber:
|
1398
|
-
description: A single number value.
|
1399
|
-
format: double
|
1400
|
-
type: number
|
1401
|
-
CIAppAggregateBucketValueSingleString:
|
1402
|
-
description: A single string value.
|
1403
|
-
type: string
|
1404
|
-
CIAppAggregateBucketValueTimeseries:
|
1405
|
-
description: A timeseries array.
|
1406
|
-
items:
|
1407
|
-
$ref: '#/components/schemas/CIAppAggregateBucketValueTimeseriesPoint'
|
1408
|
-
type: array
|
1409
|
-
x-generate-alias-as-model: true
|
1410
|
-
CIAppAggregateBucketValueTimeseriesPoint:
|
1411
|
-
description: A timeseries point.
|
1412
|
-
properties:
|
1413
|
-
time:
|
1414
|
-
description: The time value for this point.
|
1415
|
-
example: '2020-06-08T11:55:00.123Z'
|
1416
|
-
format: date-time
|
1559
|
+
bucket_name:
|
1560
|
+
description: The AWS bucket name used to store the Cost and Usage Report.
|
1561
|
+
example: dd-cost-bucket
|
1417
1562
|
type: string
|
1418
|
-
|
1419
|
-
description: The
|
1420
|
-
example:
|
1421
|
-
format: double
|
1422
|
-
type: number
|
1423
|
-
type: object
|
1424
|
-
CIAppAggregateSort:
|
1425
|
-
description: A sort rule.
|
1426
|
-
example:
|
1427
|
-
aggregation: count
|
1428
|
-
order: asc
|
1429
|
-
properties:
|
1430
|
-
aggregation:
|
1431
|
-
$ref: '#/components/schemas/CIAppAggregationFunction'
|
1432
|
-
metric:
|
1433
|
-
description: The metric to sort by (only used for `type=measure`).
|
1434
|
-
example: '@duration'
|
1563
|
+
bucket_region:
|
1564
|
+
description: The region the bucket is located in.
|
1565
|
+
example: us-east-1
|
1435
1566
|
type: string
|
1436
|
-
|
1437
|
-
|
1438
|
-
|
1439
|
-
|
1567
|
+
is_enabled:
|
1568
|
+
description: Whether or not the Cloud Cost Management account is enabled.
|
1569
|
+
type: boolean
|
1570
|
+
months:
|
1571
|
+
description: The month of the report.
|
1572
|
+
format: int32
|
1573
|
+
maximum: 36
|
1574
|
+
type: integer
|
1575
|
+
report_name:
|
1576
|
+
description: The name of the Cost and Usage Report.
|
1577
|
+
example: dd-report-name
|
1578
|
+
type: string
|
1579
|
+
report_prefix:
|
1580
|
+
description: The report prefix used for the Cost and Usage Report.
|
1581
|
+
example: dd-report-prefix
|
1582
|
+
type: string
|
1583
|
+
required:
|
1584
|
+
- account_id
|
1585
|
+
- bucket_name
|
1586
|
+
- report_name
|
1587
|
+
- report_prefix
|
1440
1588
|
type: object
|
1441
|
-
|
1442
|
-
default:
|
1443
|
-
description:
|
1589
|
+
AwsCURConfigPostRequestType:
|
1590
|
+
default: aws_cur_config_post_request
|
1591
|
+
description: Type of AWS CUR config Post Request.
|
1444
1592
|
enum:
|
1445
|
-
-
|
1446
|
-
|
1593
|
+
- aws_cur_config_post_request
|
1594
|
+
example: aws_cur_config_post_request
|
1447
1595
|
type: string
|
1448
1596
|
x-enum-varnames:
|
1449
|
-
-
|
1450
|
-
|
1451
|
-
|
1452
|
-
|
1597
|
+
- AWS_CUR_CONFIG_POST_REQUEST
|
1598
|
+
AwsCURConfigResponse:
|
1599
|
+
description: Response of AWS CUR config.
|
1600
|
+
properties:
|
1601
|
+
data:
|
1602
|
+
$ref: '#/components/schemas/AwsCURConfig'
|
1603
|
+
type: object
|
1604
|
+
AwsCURConfigType:
|
1605
|
+
default: aws_cur_config
|
1606
|
+
description: Type of AWS CUR config.
|
1453
1607
|
enum:
|
1454
|
-
-
|
1455
|
-
|
1456
|
-
|
1457
|
-
-
|
1608
|
+
- aws_cur_config
|
1609
|
+
example: aws_cur_config
|
1610
|
+
type: string
|
1611
|
+
x-enum-varnames:
|
1612
|
+
- AWS_CUR_CONFIG
|
1613
|
+
AwsCURConfigsResponse:
|
1614
|
+
description: List of AWS CUR configs.
|
1615
|
+
properties:
|
1616
|
+
data:
|
1617
|
+
description: An AWS CUR config.
|
1618
|
+
items:
|
1619
|
+
$ref: '#/components/schemas/AwsCURConfig'
|
1620
|
+
type: array
|
1621
|
+
type: object
|
1622
|
+
AzureUCConfig:
|
1623
|
+
description: Azure config.
|
1624
|
+
properties:
|
1625
|
+
account_id:
|
1626
|
+
description: The tenant ID of the azure account.
|
1627
|
+
example: 1234abcd-1234-abcd-1234-1234abcd1234
|
1628
|
+
type: string
|
1629
|
+
client_id:
|
1630
|
+
description: The client ID of the Azure account.
|
1631
|
+
example: 1234abcd-1234-abcd-1234-1234abcd1234
|
1632
|
+
type: string
|
1633
|
+
created_at:
|
1634
|
+
description: The timestamp when the Azure config was created.
|
1635
|
+
pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{6}$
|
1636
|
+
type: string
|
1637
|
+
dataset_type:
|
1638
|
+
description: The dataset type of the Azure config.
|
1639
|
+
example: actual
|
1640
|
+
type: string
|
1641
|
+
error_messages:
|
1642
|
+
description: The error messages for the Azure config.
|
1643
|
+
items:
|
1644
|
+
type: string
|
1645
|
+
type: array
|
1646
|
+
export_name:
|
1647
|
+
description: The name of the configured Azure Export.
|
1648
|
+
example: dd-actual-export
|
1649
|
+
type: string
|
1650
|
+
export_path:
|
1651
|
+
description: The path where the Azure Export is saved.
|
1652
|
+
example: dd-export-path
|
1653
|
+
type: string
|
1654
|
+
id:
|
1655
|
+
description: The ID of the Azure config.
|
1656
|
+
format: int64
|
1657
|
+
type: integer
|
1658
|
+
months:
|
1659
|
+
deprecated: true
|
1660
|
+
description: The number of months the report has been backfilled.
|
1661
|
+
format: int32
|
1662
|
+
maximum: 36
|
1663
|
+
type: integer
|
1664
|
+
scope:
|
1665
|
+
description: The scope of your observed subscription.
|
1666
|
+
example: subscriptions/1234abcd-1234-abcd-1234-1234abcd1234
|
1667
|
+
type: string
|
1668
|
+
status:
|
1669
|
+
description: The status of the Azure config.
|
1670
|
+
example: active
|
1671
|
+
type: string
|
1672
|
+
status_updated_at:
|
1673
|
+
description: The timestamp when the Azure config status was last updated.
|
1674
|
+
pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{6}$
|
1675
|
+
type: string
|
1676
|
+
storage_account:
|
1677
|
+
description: The name of the storage account where the Azure Export is saved.
|
1678
|
+
example: dd-storage-account
|
1679
|
+
type: string
|
1680
|
+
storage_container:
|
1681
|
+
description: The name of the storage container where the Azure Export is
|
1682
|
+
saved.
|
1683
|
+
example: dd-storage-container
|
1684
|
+
type: string
|
1685
|
+
updated_at:
|
1686
|
+
description: The timestamp when the Azure config was last updated.
|
1687
|
+
pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{6}$
|
1688
|
+
type: string
|
1689
|
+
required:
|
1690
|
+
- account_id
|
1691
|
+
- client_id
|
1692
|
+
- dataset_type
|
1693
|
+
- export_name
|
1694
|
+
- export_path
|
1695
|
+
- scope
|
1696
|
+
- status
|
1697
|
+
- storage_account
|
1698
|
+
- storage_container
|
1699
|
+
type: object
|
1700
|
+
AzureUCConfigPair:
|
1701
|
+
description: Azure config pair.
|
1702
|
+
properties:
|
1703
|
+
attributes:
|
1704
|
+
$ref: '#/components/schemas/AzureUCConfigPairAttributes'
|
1705
|
+
id:
|
1706
|
+
description: The ID of Cloud Cost Management account.
|
1707
|
+
format: int64
|
1708
|
+
type: integer
|
1709
|
+
type:
|
1710
|
+
$ref: '#/components/schemas/AzureUCConfigPairType'
|
1711
|
+
required:
|
1712
|
+
- attributes
|
1713
|
+
- type
|
1714
|
+
type: object
|
1715
|
+
AzureUCConfigPairAttributes:
|
1716
|
+
description: Attributes for Azure config pair.
|
1717
|
+
properties:
|
1718
|
+
configs:
|
1719
|
+
description: An Azure config.
|
1720
|
+
items:
|
1721
|
+
$ref: '#/components/schemas/AzureUCConfig'
|
1722
|
+
type: array
|
1723
|
+
id:
|
1724
|
+
description: The ID of the Azure config pair.
|
1725
|
+
format: int64
|
1726
|
+
type: integer
|
1727
|
+
required:
|
1728
|
+
- configs
|
1729
|
+
type: object
|
1730
|
+
AzureUCConfigPairType:
|
1731
|
+
default: azure_uc_configs
|
1732
|
+
description: Type of Azure config pair.
|
1733
|
+
enum:
|
1734
|
+
- azure_uc_configs
|
1735
|
+
example: azure_uc_configs
|
1736
|
+
type: string
|
1737
|
+
x-enum-varnames:
|
1738
|
+
- AZURE_UC_CONFIGS
|
1739
|
+
AzureUCConfigPairsResponse:
|
1740
|
+
description: Response of Azure config pair.
|
1741
|
+
properties:
|
1742
|
+
data:
|
1743
|
+
$ref: '#/components/schemas/AzureUCConfigPair'
|
1744
|
+
type: object
|
1745
|
+
AzureUCConfigPatchData:
|
1746
|
+
description: Azure config Patch data.
|
1747
|
+
properties:
|
1748
|
+
attributes:
|
1749
|
+
$ref: '#/components/schemas/AzureUCConfigPatchRequestAttributes'
|
1750
|
+
type:
|
1751
|
+
$ref: '#/components/schemas/AzureUCConfigPatchRequestType'
|
1752
|
+
required:
|
1753
|
+
- attributes
|
1754
|
+
- type
|
1755
|
+
type: object
|
1756
|
+
AzureUCConfigPatchRequest:
|
1757
|
+
description: Azure config Patch Request.
|
1758
|
+
properties:
|
1759
|
+
data:
|
1760
|
+
$ref: '#/components/schemas/AzureUCConfigPatchData'
|
1761
|
+
required:
|
1762
|
+
- data
|
1763
|
+
type: object
|
1764
|
+
AzureUCConfigPatchRequestAttributes:
|
1765
|
+
description: Attributes for Azure config Patch Request.
|
1766
|
+
properties:
|
1767
|
+
is_enabled:
|
1768
|
+
description: Whether or not the Cloud Cost Management account is enabled.
|
1769
|
+
example: true
|
1770
|
+
type: boolean
|
1771
|
+
required:
|
1772
|
+
- is_enabled
|
1773
|
+
type: object
|
1774
|
+
AzureUCConfigPatchRequestType:
|
1775
|
+
default: azure_uc_config_patch_request
|
1776
|
+
description: Type of Azure config Patch Request.
|
1777
|
+
enum:
|
1778
|
+
- azure_uc_config_patch_request
|
1779
|
+
example: azure_uc_config_patch_request
|
1780
|
+
type: string
|
1781
|
+
x-enum-varnames:
|
1782
|
+
- AZURE_UC_CONFIG_PATCH_REQUEST
|
1783
|
+
AzureUCConfigPostData:
|
1784
|
+
description: Azure config Post data.
|
1785
|
+
properties:
|
1786
|
+
attributes:
|
1787
|
+
$ref: '#/components/schemas/AzureUCConfigPostRequestAttributes'
|
1788
|
+
type:
|
1789
|
+
$ref: '#/components/schemas/AzureUCConfigPostRequestType'
|
1790
|
+
required:
|
1791
|
+
- attributes
|
1792
|
+
- type
|
1793
|
+
type: object
|
1794
|
+
AzureUCConfigPostRequest:
|
1795
|
+
description: Azure config Post Request.
|
1796
|
+
properties:
|
1797
|
+
data:
|
1798
|
+
$ref: '#/components/schemas/AzureUCConfigPostData'
|
1799
|
+
required:
|
1800
|
+
- data
|
1801
|
+
type: object
|
1802
|
+
AzureUCConfigPostRequestAttributes:
|
1803
|
+
description: Attributes for Azure config Post Request.
|
1804
|
+
properties:
|
1805
|
+
account_id:
|
1806
|
+
description: The tenant ID of the azure account.
|
1807
|
+
example: 1234abcd-1234-abcd-1234-1234abcd1234
|
1808
|
+
type: string
|
1809
|
+
actual_bill_config:
|
1810
|
+
$ref: '#/components/schemas/BillConfig'
|
1811
|
+
amortized_bill_config:
|
1812
|
+
$ref: '#/components/schemas/BillConfig'
|
1813
|
+
client_id:
|
1814
|
+
description: The client ID of the azure account.
|
1815
|
+
example: 1234abcd-1234-abcd-1234-1234abcd1234
|
1816
|
+
type: string
|
1817
|
+
is_enabled:
|
1818
|
+
description: Whether or not the Cloud Cost Management account is enabled.
|
1819
|
+
type: boolean
|
1820
|
+
scope:
|
1821
|
+
description: The scope of your observed subscription.
|
1822
|
+
example: subscriptions/1234abcd-1234-abcd-1234-1234abcd1234
|
1823
|
+
type: string
|
1824
|
+
required:
|
1825
|
+
- account_id
|
1826
|
+
- actual_bill_config
|
1827
|
+
- amortized_bill_config
|
1828
|
+
- client_id
|
1829
|
+
- scope
|
1830
|
+
type: object
|
1831
|
+
AzureUCConfigPostRequestType:
|
1832
|
+
default: azure_uc_config_post_request
|
1833
|
+
description: Type of Azure config Post Request.
|
1834
|
+
enum:
|
1835
|
+
- azure_uc_config_post_request
|
1836
|
+
example: azure_uc_config_post_request
|
1837
|
+
type: string
|
1838
|
+
x-enum-varnames:
|
1839
|
+
- AZURE_UC_CONFIG_POST_REQUEST
|
1840
|
+
AzureUCConfigsResponse:
|
1841
|
+
description: List of Azure accounts with configs.
|
1842
|
+
properties:
|
1843
|
+
data:
|
1844
|
+
description: An Azure config pair.
|
1845
|
+
items:
|
1846
|
+
$ref: '#/components/schemas/AzureUCConfigPair'
|
1847
|
+
type: array
|
1848
|
+
type: object
|
1849
|
+
BillConfig:
|
1850
|
+
description: Bill config.
|
1851
|
+
properties:
|
1852
|
+
export_name:
|
1853
|
+
description: The name of the configured Azure Export.
|
1854
|
+
example: dd-actual-export
|
1855
|
+
type: string
|
1856
|
+
export_path:
|
1857
|
+
description: The path where the Azure Export is saved.
|
1858
|
+
example: dd-export-path
|
1859
|
+
type: string
|
1860
|
+
storage_account:
|
1861
|
+
description: The name of the storage account where the Azure Export is saved.
|
1862
|
+
example: dd-storage-account
|
1863
|
+
type: string
|
1864
|
+
storage_container:
|
1865
|
+
description: The name of the storage container where the Azure Export is
|
1866
|
+
saved.
|
1867
|
+
example: dd-storage-container
|
1868
|
+
type: string
|
1869
|
+
required:
|
1870
|
+
- export_name
|
1871
|
+
- export_path
|
1872
|
+
- storage_account
|
1873
|
+
- storage_container
|
1874
|
+
type: object
|
1875
|
+
BulkMuteFindingsRequest:
|
1876
|
+
description: The new bulk mute finding request.
|
1877
|
+
properties:
|
1878
|
+
data:
|
1879
|
+
$ref: '#/components/schemas/BulkMuteFindingsRequestData'
|
1880
|
+
required:
|
1881
|
+
- data
|
1882
|
+
type: object
|
1883
|
+
BulkMuteFindingsRequestAttributes:
|
1884
|
+
additionalProperties: false
|
1885
|
+
description: The mute properties to be updated.
|
1886
|
+
properties:
|
1887
|
+
mute:
|
1888
|
+
$ref: '#/components/schemas/BulkMuteFindingsRequestProperties'
|
1889
|
+
required:
|
1890
|
+
- mute
|
1891
|
+
type: object
|
1892
|
+
BulkMuteFindingsRequestData:
|
1893
|
+
description: Data object containing the new bulk mute properties of the finding.
|
1894
|
+
properties:
|
1895
|
+
attributes:
|
1896
|
+
$ref: '#/components/schemas/BulkMuteFindingsRequestAttributes'
|
1897
|
+
id:
|
1898
|
+
description: UUID to identify the request
|
1899
|
+
example: dbe5f567-192b-4404-b908-29b70e1c9f76
|
1900
|
+
type: string
|
1901
|
+
meta:
|
1902
|
+
$ref: '#/components/schemas/BulkMuteFindingsRequestMeta'
|
1903
|
+
type:
|
1904
|
+
$ref: '#/components/schemas/FindingType'
|
1905
|
+
required:
|
1906
|
+
- id
|
1907
|
+
- type
|
1908
|
+
- attributes
|
1909
|
+
- meta
|
1910
|
+
type: object
|
1911
|
+
BulkMuteFindingsRequestMeta:
|
1912
|
+
description: Meta object containing the findings to be updated.
|
1913
|
+
properties:
|
1914
|
+
findings:
|
1915
|
+
description: Array of findings.
|
1916
|
+
items:
|
1917
|
+
$ref: '#/components/schemas/BulkMuteFindingsRequestMetaFindings'
|
1918
|
+
type: array
|
1919
|
+
type: object
|
1920
|
+
BulkMuteFindingsRequestMetaFindings:
|
1921
|
+
description: Finding object containing the finding information.
|
1922
|
+
properties:
|
1923
|
+
finding_id:
|
1924
|
+
$ref: '#/components/schemas/FindingID'
|
1925
|
+
type: object
|
1926
|
+
BulkMuteFindingsRequestProperties:
|
1927
|
+
additionalProperties: false
|
1928
|
+
description: Object containing the new mute properties of the findings.
|
1929
|
+
properties:
|
1930
|
+
description:
|
1931
|
+
description: Additional information about the reason why those findings
|
1932
|
+
are muted or unmuted. This field has a maximum limit of 280 characters.
|
1933
|
+
type: string
|
1934
|
+
expiration_date:
|
1935
|
+
description: 'The expiration date of the mute or unmute action (Unix ms).
|
1936
|
+
It must be set to a value greater than the current timestamp.
|
1937
|
+
|
1938
|
+
If this field is not provided, the finding will be muted or unmuted indefinitely,
|
1939
|
+
which is equivalent to setting the expiration date to 9999999999999.
|
1940
|
+
|
1941
|
+
'
|
1942
|
+
example: 1778721573794
|
1943
|
+
format: int64
|
1944
|
+
type: integer
|
1945
|
+
muted:
|
1946
|
+
description: Whether those findings should be muted or unmuted.
|
1947
|
+
example: true
|
1948
|
+
type: boolean
|
1949
|
+
reason:
|
1950
|
+
$ref: '#/components/schemas/FindingMuteReason'
|
1951
|
+
required:
|
1952
|
+
- muted
|
1953
|
+
- reason
|
1954
|
+
type: object
|
1955
|
+
BulkMuteFindingsResponse:
|
1956
|
+
description: The expected response schema.
|
1957
|
+
properties:
|
1958
|
+
data:
|
1959
|
+
$ref: '#/components/schemas/BulkMuteFindingsResponseData'
|
1960
|
+
required:
|
1961
|
+
- data
|
1962
|
+
type: object
|
1963
|
+
BulkMuteFindingsResponseData:
|
1964
|
+
description: Data object containing the ID of the request that was updated.
|
1965
|
+
properties:
|
1966
|
+
id:
|
1967
|
+
description: UUID used to identify the request
|
1968
|
+
example: 93bfeb70-af47-424d-908a-948d3f08e37f
|
1969
|
+
type: string
|
1970
|
+
type:
|
1971
|
+
$ref: '#/components/schemas/FindingType'
|
1972
|
+
type: object
|
1973
|
+
CIAppAggregateBucketValue:
|
1974
|
+
description: A bucket value, can either be a timeseries or a single value.
|
1975
|
+
oneOf:
|
1976
|
+
- $ref: '#/components/schemas/CIAppAggregateBucketValueSingleString'
|
1977
|
+
- $ref: '#/components/schemas/CIAppAggregateBucketValueSingleNumber'
|
1978
|
+
- $ref: '#/components/schemas/CIAppAggregateBucketValueTimeseries'
|
1979
|
+
CIAppAggregateBucketValueSingleNumber:
|
1980
|
+
description: A single number value.
|
1981
|
+
format: double
|
1982
|
+
type: number
|
1983
|
+
CIAppAggregateBucketValueSingleString:
|
1984
|
+
description: A single string value.
|
1985
|
+
type: string
|
1986
|
+
CIAppAggregateBucketValueTimeseries:
|
1987
|
+
description: A timeseries array.
|
1988
|
+
items:
|
1989
|
+
$ref: '#/components/schemas/CIAppAggregateBucketValueTimeseriesPoint'
|
1990
|
+
type: array
|
1991
|
+
x-generate-alias-as-model: true
|
1992
|
+
CIAppAggregateBucketValueTimeseriesPoint:
|
1993
|
+
description: A timeseries point.
|
1994
|
+
properties:
|
1995
|
+
time:
|
1996
|
+
description: The time value for this point.
|
1997
|
+
example: '2020-06-08T11:55:00.123Z'
|
1998
|
+
format: date-time
|
1999
|
+
type: string
|
2000
|
+
value:
|
2001
|
+
description: The value for this point.
|
2002
|
+
example: 19
|
2003
|
+
format: double
|
2004
|
+
type: number
|
2005
|
+
type: object
|
2006
|
+
CIAppAggregateSort:
|
2007
|
+
description: A sort rule.
|
2008
|
+
example:
|
2009
|
+
aggregation: count
|
2010
|
+
order: asc
|
2011
|
+
properties:
|
2012
|
+
aggregation:
|
2013
|
+
$ref: '#/components/schemas/CIAppAggregationFunction'
|
2014
|
+
metric:
|
2015
|
+
description: The metric to sort by (only used for `type=measure`).
|
2016
|
+
example: '@duration'
|
2017
|
+
type: string
|
2018
|
+
order:
|
2019
|
+
$ref: '#/components/schemas/CIAppSortOrder'
|
2020
|
+
type:
|
2021
|
+
$ref: '#/components/schemas/CIAppAggregateSortType'
|
2022
|
+
type: object
|
2023
|
+
CIAppAggregateSortType:
|
2024
|
+
default: alphabetical
|
2025
|
+
description: The type of sorting algorithm.
|
2026
|
+
enum:
|
2027
|
+
- alphabetical
|
2028
|
+
- measure
|
2029
|
+
type: string
|
2030
|
+
x-enum-varnames:
|
2031
|
+
- ALPHABETICAL
|
2032
|
+
- MEASURE
|
2033
|
+
CIAppAggregationFunction:
|
2034
|
+
description: An aggregation function.
|
2035
|
+
enum:
|
2036
|
+
- count
|
2037
|
+
- cardinality
|
2038
|
+
- pc75
|
2039
|
+
- pc90
|
1458
2040
|
- pc95
|
1459
2041
|
- pc98
|
1460
2042
|
- pc99
|
@@ -2917,15 +3499,51 @@ components:
|
|
2917
3499
|
complianceRuleOptions:
|
2918
3500
|
$ref: '#/components/schemas/CloudConfigurationComplianceRuleOptions'
|
2919
3501
|
required:
|
2920
|
-
- complianceRuleOptions
|
3502
|
+
- complianceRuleOptions
|
3503
|
+
type: object
|
3504
|
+
CloudConfigurationRuleType:
|
3505
|
+
description: The rule type.
|
3506
|
+
enum:
|
3507
|
+
- cloud_configuration
|
3508
|
+
type: string
|
3509
|
+
x-enum-varnames:
|
3510
|
+
- CLOUD_CONFIGURATION
|
3511
|
+
CloudCostActivity:
|
3512
|
+
description: Cloud Cost Activity.
|
3513
|
+
properties:
|
3514
|
+
attributes:
|
3515
|
+
$ref: '#/components/schemas/CloudCostActivityAttributes'
|
3516
|
+
type:
|
3517
|
+
$ref: '#/components/schemas/CloudCostActivityType'
|
3518
|
+
required:
|
3519
|
+
- attributes
|
3520
|
+
- type
|
3521
|
+
type: object
|
3522
|
+
CloudCostActivityAttributes:
|
3523
|
+
description: Attributes for Cloud Cost activity.
|
3524
|
+
properties:
|
3525
|
+
is_enabled:
|
3526
|
+
description: Whether or not the cloud account is enabled.
|
3527
|
+
example: true
|
3528
|
+
type: boolean
|
3529
|
+
required:
|
3530
|
+
- is_enabled
|
2921
3531
|
type: object
|
2922
|
-
|
2923
|
-
description:
|
3532
|
+
CloudCostActivityResponse:
|
3533
|
+
description: Response for Cloud Cost activity.
|
3534
|
+
properties:
|
3535
|
+
data:
|
3536
|
+
$ref: '#/components/schemas/CloudCostActivity'
|
3537
|
+
type: object
|
3538
|
+
CloudCostActivityType:
|
3539
|
+
default: cloud_cost_activity
|
3540
|
+
description: Type of Cloud Cost Activity.
|
2924
3541
|
enum:
|
2925
|
-
-
|
3542
|
+
- cloud_cost_activity
|
3543
|
+
example: cloud_cost_activity
|
2926
3544
|
type: string
|
2927
3545
|
x-enum-varnames:
|
2928
|
-
-
|
3546
|
+
- CLOUD_COST_ACTIVITY
|
2929
3547
|
CloudWorkloadSecurityAgentRuleAttributes:
|
2930
3548
|
description: A Cloud Workload Security Agent rule returned by the API.
|
2931
3549
|
properties:
|
@@ -2963,6 +3581,11 @@ components:
|
|
2963
3581
|
description: The SECL expression of the Agent rule.
|
2964
3582
|
example: exec.file.name == \"sh\"
|
2965
3583
|
type: string
|
3584
|
+
filters:
|
3585
|
+
description: The platforms the Agent rule is supported on.
|
3586
|
+
items:
|
3587
|
+
type: string
|
3588
|
+
type: array
|
2966
3589
|
name:
|
2967
3590
|
description: The name of the Agent rule.
|
2968
3591
|
example: my_agent_rule
|
@@ -3153,6 +3776,22 @@ components:
|
|
3153
3776
|
description: The name of the Cloudflare account.
|
3154
3777
|
example: test-name
|
3155
3778
|
type: string
|
3779
|
+
resources:
|
3780
|
+
description: An allowlist of resources to restrict pulling metrics for.
|
3781
|
+
example:
|
3782
|
+
- web
|
3783
|
+
- dns
|
3784
|
+
items:
|
3785
|
+
type: string
|
3786
|
+
type: array
|
3787
|
+
zones:
|
3788
|
+
description: An allowlist of zones to restrict pulling metrics for.
|
3789
|
+
example:
|
3790
|
+
- zone_id_1
|
3791
|
+
- zone_id_2
|
3792
|
+
items:
|
3793
|
+
type: string
|
3794
|
+
type: array
|
3156
3795
|
required:
|
3157
3796
|
- api_key
|
3158
3797
|
- name
|
@@ -3185,6 +3824,22 @@ components:
|
|
3185
3824
|
description: The name of the Cloudflare account.
|
3186
3825
|
example: test-name
|
3187
3826
|
type: string
|
3827
|
+
resources:
|
3828
|
+
description: An allowlist of resources to restrict pulling metrics for.
|
3829
|
+
example:
|
3830
|
+
- web
|
3831
|
+
- dns
|
3832
|
+
items:
|
3833
|
+
type: string
|
3834
|
+
type: array
|
3835
|
+
zones:
|
3836
|
+
description: An allowlist of zones to restrict pulling metrics for.
|
3837
|
+
example:
|
3838
|
+
- zone_id_1
|
3839
|
+
- zone_id_2
|
3840
|
+
items:
|
3841
|
+
type: string
|
3842
|
+
type: array
|
3188
3843
|
required:
|
3189
3844
|
- name
|
3190
3845
|
type: object
|
@@ -3233,6 +3888,22 @@ components:
|
|
3233
3888
|
key is provided (and not a token), this field is also required.
|
3234
3889
|
example: test-email@example.com
|
3235
3890
|
type: string
|
3891
|
+
resources:
|
3892
|
+
description: An allowlist of resources to restrict pulling metrics for.
|
3893
|
+
example:
|
3894
|
+
- web
|
3895
|
+
- dns
|
3896
|
+
items:
|
3897
|
+
type: string
|
3898
|
+
type: array
|
3899
|
+
zones:
|
3900
|
+
description: An allowlist of zones to restrict pulling metrics for.
|
3901
|
+
example:
|
3902
|
+
- zone_id_1
|
3903
|
+
- zone_id_2
|
3904
|
+
items:
|
3905
|
+
type: string
|
3906
|
+
type: array
|
3236
3907
|
required:
|
3237
3908
|
- api_key
|
3238
3909
|
type: object
|
@@ -4082,6 +4753,63 @@ components:
|
|
4082
4753
|
- IDENTITY
|
4083
4754
|
- GZIP
|
4084
4755
|
- DEFLATE
|
4756
|
+
CostAttributionAggregates:
|
4757
|
+
description: An array of available aggregates.
|
4758
|
+
items:
|
4759
|
+
$ref: '#/components/schemas/CostAttributionAggregatesBody'
|
4760
|
+
type: array
|
4761
|
+
CostAttributionAggregatesBody:
|
4762
|
+
description: The object containing the aggregates.
|
4763
|
+
properties:
|
4764
|
+
agg_type:
|
4765
|
+
description: The aggregate type.
|
4766
|
+
example: sum
|
4767
|
+
type: string
|
4768
|
+
field:
|
4769
|
+
description: The field.
|
4770
|
+
example: infra_host_committed_cost
|
4771
|
+
type: string
|
4772
|
+
value:
|
4773
|
+
description: The value for a given field.
|
4774
|
+
format: double
|
4775
|
+
type: number
|
4776
|
+
type: object
|
4777
|
+
CostAttributionTagNames:
|
4778
|
+
additionalProperties:
|
4779
|
+
description: 'A list of values that are associated with each tag key.
|
4780
|
+
|
4781
|
+
- An empty list means the resource use wasn''t tagged with the respective
|
4782
|
+
tag.
|
4783
|
+
|
4784
|
+
- Multiple values means the respective tag was applied multiple times on
|
4785
|
+
the resource.
|
4786
|
+
|
4787
|
+
- An `<empty>` value means the resource was tagged with the respective tag
|
4788
|
+
but did not have a value.'
|
4789
|
+
items:
|
4790
|
+
description: A given tag in a list.
|
4791
|
+
example: datadog-integrations-lab
|
4792
|
+
type: string
|
4793
|
+
type: array
|
4794
|
+
description: 'Tag keys and values.
|
4795
|
+
|
4796
|
+
A `null` value here means that the requested tag breakdown cannot be applied
|
4797
|
+
because it does not match the [tags
|
4798
|
+
|
4799
|
+
configured for usage attribution](https://docs.datadoghq.com/account_management/billing/usage_attribution/#getting-started).
|
4800
|
+
|
4801
|
+
In this scenario the API returns the total cost, not broken down by tags.'
|
4802
|
+
nullable: true
|
4803
|
+
type: object
|
4804
|
+
CostAttributionType:
|
4805
|
+
default: cost_by_tag
|
4806
|
+
description: Type of cost attribution data.
|
4807
|
+
enum:
|
4808
|
+
- cost_by_tag
|
4809
|
+
example: cost_by_tag
|
4810
|
+
type: string
|
4811
|
+
x-enum-varnames:
|
4812
|
+
- COST_BY_TAG
|
4085
4813
|
CostByOrg:
|
4086
4814
|
description: Cost data.
|
4087
4815
|
properties:
|
@@ -4184,6 +4912,178 @@ components:
|
|
4184
4912
|
nullable: true
|
4185
4913
|
type: string
|
4186
4914
|
type: object
|
4915
|
+
DORADeploymentRequest:
|
4916
|
+
description: Request to create a DORA deployment event.
|
4917
|
+
properties:
|
4918
|
+
data:
|
4919
|
+
$ref: '#/components/schemas/DORADeploymentRequestData'
|
4920
|
+
required:
|
4921
|
+
- data
|
4922
|
+
type: object
|
4923
|
+
DORADeploymentRequestAttributes:
|
4924
|
+
description: Attributes to create a DORA deployment event.
|
4925
|
+
properties:
|
4926
|
+
finished_at:
|
4927
|
+
description: Unix timestamp in nanoseconds when the deployment finished.
|
4928
|
+
It should not be older than 3 hours.
|
4929
|
+
example: 1693491984000000000
|
4930
|
+
format: int64
|
4931
|
+
type: integer
|
4932
|
+
git:
|
4933
|
+
$ref: '#/components/schemas/DORAGitInfo'
|
4934
|
+
id:
|
4935
|
+
description: Deployment ID.
|
4936
|
+
type: string
|
4937
|
+
service:
|
4938
|
+
description: Service name from a service available in the Service Catalog.
|
4939
|
+
example: shopist
|
4940
|
+
type: string
|
4941
|
+
started_at:
|
4942
|
+
description: Unix timestamp in nanoseconds when the deployment started.
|
4943
|
+
example: 1693491974000000000
|
4944
|
+
format: int64
|
4945
|
+
type: integer
|
4946
|
+
version:
|
4947
|
+
description: Version to correlate with [APM Deployment Tracking](https://docs.datadoghq.com/tracing/services/deployment_tracking/).
|
4948
|
+
example: v1.12.07
|
4949
|
+
type: string
|
4950
|
+
required:
|
4951
|
+
- service
|
4952
|
+
- started_at
|
4953
|
+
- finished_at
|
4954
|
+
type: object
|
4955
|
+
DORADeploymentRequestData:
|
4956
|
+
description: The JSON:API data.
|
4957
|
+
properties:
|
4958
|
+
attributes:
|
4959
|
+
$ref: '#/components/schemas/DORADeploymentRequestAttributes'
|
4960
|
+
required:
|
4961
|
+
- attributes
|
4962
|
+
type: object
|
4963
|
+
DORADeploymentResponse:
|
4964
|
+
description: Response after receiving a DORA deployment event.
|
4965
|
+
properties:
|
4966
|
+
data:
|
4967
|
+
$ref: '#/components/schemas/DORADeploymentResponseData'
|
4968
|
+
required:
|
4969
|
+
- data
|
4970
|
+
type: object
|
4971
|
+
DORADeploymentResponseData:
|
4972
|
+
description: The JSON:API data.
|
4973
|
+
properties:
|
4974
|
+
id:
|
4975
|
+
description: The ID of the received DORA deployment event.
|
4976
|
+
example: 4242fcdd31586083
|
4977
|
+
type: string
|
4978
|
+
type:
|
4979
|
+
$ref: '#/components/schemas/DORADeploymentType'
|
4980
|
+
required:
|
4981
|
+
- id
|
4982
|
+
type: object
|
4983
|
+
DORADeploymentType:
|
4984
|
+
default: dora_deployment
|
4985
|
+
description: JSON:API type for DORA deployment events.
|
4986
|
+
enum:
|
4987
|
+
- dora_deployment
|
4988
|
+
example: dora_deployment
|
4989
|
+
type: string
|
4990
|
+
x-enum-varnames:
|
4991
|
+
- DORA_DEPLOYMENT
|
4992
|
+
DORAGitInfo:
|
4993
|
+
description: Git info for DORA Metrics events.
|
4994
|
+
properties:
|
4995
|
+
commit_sha:
|
4996
|
+
$ref: '#/components/schemas/GitCommitSHA'
|
4997
|
+
repository_url:
|
4998
|
+
$ref: '#/components/schemas/GitRepositoryURL'
|
4999
|
+
required:
|
5000
|
+
- repository_url
|
5001
|
+
- commit_sha
|
5002
|
+
type: object
|
5003
|
+
DORAIncidentRequest:
|
5004
|
+
description: Request to create a DORA incident event.
|
5005
|
+
properties:
|
5006
|
+
data:
|
5007
|
+
$ref: '#/components/schemas/DORAIncidentRequestData'
|
5008
|
+
required:
|
5009
|
+
- data
|
5010
|
+
type: object
|
5011
|
+
DORAIncidentRequestAttributes:
|
5012
|
+
description: Attributes to create a DORA incident event.
|
5013
|
+
properties:
|
5014
|
+
finished_at:
|
5015
|
+
description: Unix timestamp in nanoseconds when the incident finished. It
|
5016
|
+
should not be older than 3 hours.
|
5017
|
+
example: 1693491984000000000
|
5018
|
+
format: int64
|
5019
|
+
type: integer
|
5020
|
+
git:
|
5021
|
+
$ref: '#/components/schemas/DORAGitInfo'
|
5022
|
+
id:
|
5023
|
+
description: Incident ID
|
5024
|
+
type: string
|
5025
|
+
name:
|
5026
|
+
description: Incident name.
|
5027
|
+
example: Webserver is down failing all requests
|
5028
|
+
type: string
|
5029
|
+
service:
|
5030
|
+
description: Service name from a service available in the Service Catalog.
|
5031
|
+
example: shopist
|
5032
|
+
type: string
|
5033
|
+
severity:
|
5034
|
+
description: Incident severity.
|
5035
|
+
example: High
|
5036
|
+
type: string
|
5037
|
+
started_at:
|
5038
|
+
description: Unix timestamp in nanoseconds when the incident started.
|
5039
|
+
example: 1693491974000000000
|
5040
|
+
format: int64
|
5041
|
+
type: integer
|
5042
|
+
version:
|
5043
|
+
description: Version to correlate with [APM Deployment Tracking](https://docs.datadoghq.com/tracing/services/deployment_tracking/).
|
5044
|
+
example: v1.12.07
|
5045
|
+
type: string
|
5046
|
+
required:
|
5047
|
+
- service
|
5048
|
+
- started_at
|
5049
|
+
type: object
|
5050
|
+
DORAIncidentRequestData:
|
5051
|
+
description: The JSON:API data.
|
5052
|
+
properties:
|
5053
|
+
attributes:
|
5054
|
+
$ref: '#/components/schemas/DORAIncidentRequestAttributes'
|
5055
|
+
required:
|
5056
|
+
- attributes
|
5057
|
+
type: object
|
5058
|
+
DORAIncidentResponse:
|
5059
|
+
description: Response after receiving a DORA incident event.
|
5060
|
+
properties:
|
5061
|
+
data:
|
5062
|
+
$ref: '#/components/schemas/DORAIncidentResponseData'
|
5063
|
+
required:
|
5064
|
+
- data
|
5065
|
+
type: object
|
5066
|
+
DORAIncidentResponseData:
|
5067
|
+
description: Response after receiving a DORA incident event.
|
5068
|
+
properties:
|
5069
|
+
id:
|
5070
|
+
description: The ID of the received DORA incident event.
|
5071
|
+
example: 4242fcdd31586083
|
5072
|
+
type: string
|
5073
|
+
type:
|
5074
|
+
$ref: '#/components/schemas/DORAIncidentType'
|
5075
|
+
required:
|
5076
|
+
- id
|
5077
|
+
type: object
|
5078
|
+
DORAIncidentType:
|
5079
|
+
default: dora_incident
|
5080
|
+
description: JSON:API type for DORA incident events.
|
5081
|
+
enum:
|
5082
|
+
- dora_incident
|
5083
|
+
example: dora_incident
|
5084
|
+
type: string
|
5085
|
+
x-enum-varnames:
|
5086
|
+
- DORA_INCIDENT
|
4187
5087
|
DashboardListAddItemsRequest:
|
4188
5088
|
description: Request containing a list of dashboards to add.
|
4189
5089
|
properties:
|
@@ -5927,6 +6827,9 @@ components:
|
|
5927
6827
|
FullAPIKeyAttributes:
|
5928
6828
|
description: Attributes of a full API key.
|
5929
6829
|
properties:
|
6830
|
+
category:
|
6831
|
+
description: The category of the API key.
|
6832
|
+
type: string
|
5930
6833
|
created_at:
|
5931
6834
|
description: Creation date of the API key.
|
5932
6835
|
example: '2020-11-23T10:00:00.000Z'
|
@@ -5952,6 +6855,9 @@ components:
|
|
5952
6855
|
description: Name of the API key.
|
5953
6856
|
example: API Key for submitting metrics
|
5954
6857
|
type: string
|
6858
|
+
remote_config_read_enabled:
|
6859
|
+
description: The remote config read enabled status.
|
6860
|
+
type: boolean
|
5955
6861
|
type: object
|
5956
6862
|
FullApplicationKey:
|
5957
6863
|
description: Datadog application key.
|
@@ -6074,8 +6980,19 @@ components:
|
|
6074
6980
|
type: string
|
6075
6981
|
type: array
|
6076
6982
|
is_cspm_enabled:
|
6077
|
-
description: When enabled, Datadog
|
6078
|
-
|
6983
|
+
description: 'When enabled, Datadog will activate the Cloud Security Monitoring
|
6984
|
+
product for this service account. Note: This requires resource_collection_enabled
|
6985
|
+
to be set to true.'
|
6986
|
+
type: boolean
|
6987
|
+
is_security_command_center_enabled:
|
6988
|
+
default: false
|
6989
|
+
description: 'When enabled, Datadog will attempt to collect Security Command
|
6990
|
+
Center Findings. Note: This requires additional permissions on the service
|
6991
|
+
account.'
|
6992
|
+
example: true
|
6993
|
+
type: boolean
|
6994
|
+
resource_collection_enabled:
|
6995
|
+
description: When enabled, Datadog scans for all resources in your GCP environment.
|
6079
6996
|
type: boolean
|
6080
6997
|
type: object
|
6081
6998
|
GCPSTSServiceAccountCreateRequest:
|
@@ -6173,6 +7090,15 @@ components:
|
|
6173
7090
|
- _HANDLE
|
6174
7091
|
- EMAIL
|
6175
7092
|
- _EMAIL
|
7093
|
+
GitCommitSHA:
|
7094
|
+
description: Git Commit SHA.
|
7095
|
+
example: 66adc9350f2cc9b250b69abddab733dd55e1a588
|
7096
|
+
pattern: ^[a-fA-F0-9]{40,}$
|
7097
|
+
type: string
|
7098
|
+
GitRepositoryURL:
|
7099
|
+
description: Git Repository URL
|
7100
|
+
example: https://github.com/organization/example-repository
|
7101
|
+
type: string
|
6176
7102
|
GroupScalarColumn:
|
6177
7103
|
description: A column containing the tag keys and values in a group.
|
6178
7104
|
properties:
|
@@ -6566,6 +7492,11 @@ components:
|
|
6566
7492
|
$ref: '#/components/schemas/IncidentAttachmentLinkAttributesAttachmentObject'
|
6567
7493
|
attachment_type:
|
6568
7494
|
$ref: '#/components/schemas/IncidentAttachmentLinkAttachmentType'
|
7495
|
+
modified:
|
7496
|
+
description: Timestamp when the incident attachment link was last modified.
|
7497
|
+
format: date-time
|
7498
|
+
readOnly: true
|
7499
|
+
type: string
|
6569
7500
|
required:
|
6570
7501
|
- attachment_type
|
6571
7502
|
- attachment
|
@@ -6871,9 +7802,22 @@ components:
|
|
6871
7802
|
- TEXTARRAY
|
6872
7803
|
- METRICTAG
|
6873
7804
|
- AUTOCOMPLETE
|
7805
|
+
IncidentImpactsType:
|
7806
|
+
description: The incident impacts type.
|
7807
|
+
enum:
|
7808
|
+
- incident_impacts
|
7809
|
+
example: incident_impacts
|
7810
|
+
type: string
|
7811
|
+
x-enum-varnames:
|
7812
|
+
- INCIDENT_IMPACTS
|
6874
7813
|
IncidentIntegrationMetadataAttributes:
|
6875
7814
|
description: Incident integration metadata's attributes for a create request.
|
6876
7815
|
properties:
|
7816
|
+
created:
|
7817
|
+
description: Timestamp when the incident todo was created.
|
7818
|
+
format: date-time
|
7819
|
+
readOnly: true
|
7820
|
+
type: string
|
6877
7821
|
incident_id:
|
6878
7822
|
description: UUID of the incident this integration metadata is connected
|
6879
7823
|
to.
|
@@ -6890,6 +7834,11 @@ components:
|
|
6890
7834
|
type: integer
|
6891
7835
|
metadata:
|
6892
7836
|
$ref: '#/components/schemas/IncidentIntegrationMetadataMetadata'
|
7837
|
+
modified:
|
7838
|
+
description: Timestamp when the incident todo was last modified.
|
7839
|
+
format: date-time
|
7840
|
+
readOnly: true
|
7841
|
+
type: string
|
6893
7842
|
status:
|
6894
7843
|
description: 'A number indicating the status of this integration metadata.
|
6895
7844
|
0 indicates unknown;
|
@@ -6989,6 +7938,8 @@ components:
|
|
6989
7938
|
description: The incident integration metadata's ID.
|
6990
7939
|
example: 00000000-0000-0000-1234-000000000000
|
6991
7940
|
type: string
|
7941
|
+
relationships:
|
7942
|
+
$ref: '#/components/schemas/IncidentIntegrationRelationships'
|
6992
7943
|
type:
|
6993
7944
|
$ref: '#/components/schemas/IncidentIntegrationMetadataType'
|
6994
7945
|
required:
|
@@ -7009,6 +7960,25 @@ components:
|
|
7009
7960
|
type: string
|
7010
7961
|
x-enum-varnames:
|
7011
7962
|
- INCIDENT_INTEGRATIONS
|
7963
|
+
IncidentIntegrationRelationships:
|
7964
|
+
description: The incident's integration relationships from a response.
|
7965
|
+
properties:
|
7966
|
+
created_by_user:
|
7967
|
+
$ref: '#/components/schemas/RelationshipToUser'
|
7968
|
+
last_modified_by_user:
|
7969
|
+
$ref: '#/components/schemas/RelationshipToUser'
|
7970
|
+
type: object
|
7971
|
+
IncidentNonDatadogCreator:
|
7972
|
+
description: Incident's non Datadog creator.
|
7973
|
+
nullable: true
|
7974
|
+
properties:
|
7975
|
+
image_48_px:
|
7976
|
+
description: Non Datadog creator `48px` image.
|
7977
|
+
type: string
|
7978
|
+
name:
|
7979
|
+
description: Non Datadog creator name.
|
7980
|
+
type: string
|
7981
|
+
type: object
|
7012
7982
|
IncidentNotificationHandle:
|
7013
7983
|
description: A notification handle that will be notified at incident creation.
|
7014
7984
|
properties:
|
@@ -7039,6 +8009,14 @@ components:
|
|
7039
8009
|
x-enum-varnames:
|
7040
8010
|
- USERS
|
7041
8011
|
- ATTACHMENTS
|
8012
|
+
IncidentRespondersType:
|
8013
|
+
description: The incident responders type.
|
8014
|
+
enum:
|
8015
|
+
- incident_responders
|
8016
|
+
example: incident_responders
|
8017
|
+
type: string
|
8018
|
+
x-enum-varnames:
|
8019
|
+
- INCIDENT_RESPONDERS
|
7042
8020
|
IncidentResponse:
|
7043
8021
|
description: Response with an incident.
|
7044
8022
|
properties:
|
@@ -7056,6 +8034,17 @@ components:
|
|
7056
8034
|
IncidentResponseAttributes:
|
7057
8035
|
description: The incident's attributes from a response.
|
7058
8036
|
properties:
|
8037
|
+
archived:
|
8038
|
+
description: Timestamp of when the incident was archived.
|
8039
|
+
format: date-time
|
8040
|
+
nullable: true
|
8041
|
+
readOnly: true
|
8042
|
+
type: string
|
8043
|
+
case_id:
|
8044
|
+
description: The incident case id.
|
8045
|
+
format: int64
|
8046
|
+
nullable: true
|
8047
|
+
type: integer
|
7059
8048
|
created:
|
7060
8049
|
description: Timestamp when the incident was created.
|
7061
8050
|
format: date-time
|
@@ -7106,6 +8095,8 @@ components:
|
|
7106
8095
|
format: date-time
|
7107
8096
|
readOnly: true
|
7108
8097
|
type: string
|
8098
|
+
non_datadog_creator:
|
8099
|
+
$ref: '#/components/schemas/IncidentNonDatadogCreator'
|
7109
8100
|
notification_handles:
|
7110
8101
|
description: Notification handles that will be notified of the incident
|
7111
8102
|
during update.
|
@@ -7124,6 +8115,12 @@ components:
|
|
7124
8115
|
format: date-time
|
7125
8116
|
nullable: true
|
7126
8117
|
type: string
|
8118
|
+
severity:
|
8119
|
+
$ref: '#/components/schemas/IncidentSeverity'
|
8120
|
+
state:
|
8121
|
+
description: The state incident.
|
8122
|
+
nullable: true
|
8123
|
+
type: string
|
7127
8124
|
time_to_detect:
|
7128
8125
|
description: 'The amount of time in seconds to detect the incident.
|
7129
8126
|
|
@@ -7154,6 +8151,10 @@ components:
|
|
7154
8151
|
description: The title of the incident, which summarizes what happened.
|
7155
8152
|
example: A test incident title
|
7156
8153
|
type: string
|
8154
|
+
visibility:
|
8155
|
+
description: The incident visibility status.
|
8156
|
+
nullable: true
|
8157
|
+
type: string
|
7157
8158
|
required:
|
7158
8159
|
- title
|
7159
8160
|
type: object
|
@@ -7215,10 +8216,16 @@ components:
|
|
7215
8216
|
$ref: '#/components/schemas/NullableRelationshipToUser'
|
7216
8217
|
created_by_user:
|
7217
8218
|
$ref: '#/components/schemas/RelationshipToUser'
|
8219
|
+
impacts:
|
8220
|
+
$ref: '#/components/schemas/RelationshipToIncidentImpacts'
|
7218
8221
|
integrations:
|
7219
8222
|
$ref: '#/components/schemas/RelationshipToIncidentIntegrationMetadatas'
|
7220
8223
|
last_modified_by_user:
|
7221
8224
|
$ref: '#/components/schemas/RelationshipToUser'
|
8225
|
+
responders:
|
8226
|
+
$ref: '#/components/schemas/RelationshipToIncidentResponders'
|
8227
|
+
user_defined_fields:
|
8228
|
+
$ref: '#/components/schemas/RelationshipToIncidentUserDefinedFields'
|
7222
8229
|
type: object
|
7223
8230
|
IncidentSearchResponse:
|
7224
8231
|
description: Response with incidents and facets.
|
@@ -7601,6 +8608,24 @@ components:
|
|
7601
8608
|
required:
|
7602
8609
|
- data
|
7603
8610
|
type: object
|
8611
|
+
IncidentSeverity:
|
8612
|
+
description: The incident severity.
|
8613
|
+
enum:
|
8614
|
+
- UNKNOWN
|
8615
|
+
- SEV-1
|
8616
|
+
- SEV-2
|
8617
|
+
- SEV-3
|
8618
|
+
- SEV-4
|
8619
|
+
- SEV-5
|
8620
|
+
example: UNKNOWN
|
8621
|
+
type: string
|
8622
|
+
x-enum-varnames:
|
8623
|
+
- UNKNOWN
|
8624
|
+
- SEV_1
|
8625
|
+
- SEV_2
|
8626
|
+
- SEV_3
|
8627
|
+
- SEV_4
|
8628
|
+
- SEV_5
|
7604
8629
|
IncidentTeamCreateAttributes:
|
7605
8630
|
description: The incident team's attributes for a create request.
|
7606
8631
|
properties:
|
@@ -7860,6 +8885,11 @@ components:
|
|
7860
8885
|
description: The follow-up task's content.
|
7861
8886
|
example: Restore lost data.
|
7862
8887
|
type: string
|
8888
|
+
created:
|
8889
|
+
description: Timestamp when the incident todo was created.
|
8890
|
+
format: date-time
|
8891
|
+
readOnly: true
|
8892
|
+
type: string
|
7863
8893
|
due_date:
|
7864
8894
|
description: Timestamp when the todo should be completed by.
|
7865
8895
|
example: '2023-07-10T05:00:00.000000+00:00'
|
@@ -7869,6 +8899,11 @@ components:
|
|
7869
8899
|
description: UUID of the incident this todo is connected to.
|
7870
8900
|
example: 00000000-aaaa-0000-0000-000000000000
|
7871
8901
|
type: string
|
8902
|
+
modified:
|
8903
|
+
description: Timestamp when the incident todo was last modified.
|
8904
|
+
format: date-time
|
8905
|
+
readOnly: true
|
8906
|
+
type: string
|
7872
8907
|
required:
|
7873
8908
|
- content
|
7874
8909
|
- assignees
|
@@ -7930,6 +8965,14 @@ components:
|
|
7930
8965
|
required:
|
7931
8966
|
- data
|
7932
8967
|
type: object
|
8968
|
+
IncidentTodoRelationships:
|
8969
|
+
description: The incident's relationships from a response.
|
8970
|
+
properties:
|
8971
|
+
created_by_user:
|
8972
|
+
$ref: '#/components/schemas/RelationshipToUser'
|
8973
|
+
last_modified_by_user:
|
8974
|
+
$ref: '#/components/schemas/RelationshipToUser'
|
8975
|
+
type: object
|
7933
8976
|
IncidentTodoResponse:
|
7934
8977
|
description: Response with an incident todo.
|
7935
8978
|
properties:
|
@@ -7953,6 +8996,8 @@ components:
|
|
7953
8996
|
description: The incident todo's ID.
|
7954
8997
|
example: 00000000-0000-0000-1234-000000000000
|
7955
8998
|
type: string
|
8999
|
+
relationships:
|
9000
|
+
$ref: '#/components/schemas/IncidentTodoRelationships'
|
7956
9001
|
type:
|
7957
9002
|
$ref: '#/components/schemas/IncidentTodoType'
|
7958
9003
|
required:
|
@@ -8063,6 +9108,14 @@ components:
|
|
8063
9108
|
required:
|
8064
9109
|
- data
|
8065
9110
|
type: object
|
9111
|
+
IncidentUserDefinedFieldType:
|
9112
|
+
description: The incident user defined fields type.
|
9113
|
+
enum:
|
9114
|
+
- user_defined_field
|
9115
|
+
example: user_defined_field
|
9116
|
+
type: string
|
9117
|
+
x-enum-varnames:
|
9118
|
+
- USER_DEFINED_FIELD
|
8066
9119
|
IncidentsResponse:
|
8067
9120
|
description: Response with a list of incidents.
|
8068
9121
|
properties:
|
@@ -8261,6 +9314,8 @@ components:
|
|
8261
9314
|
items:
|
8262
9315
|
$ref: '#/components/schemas/ApplicationKeyResponseIncludedItem'
|
8263
9316
|
type: array
|
9317
|
+
meta:
|
9318
|
+
$ref: '#/components/schemas/ApplicationKeyResponseMeta'
|
8264
9319
|
type: object
|
8265
9320
|
ListDowntimesResponse:
|
8266
9321
|
description: Response for retrieving all downtimes.
|
@@ -10750,11 +11805,81 @@ components:
|
|
10750
11805
|
variables.
|
10751
11806
|
type: string
|
10752
11807
|
type:
|
10753
|
-
description: The monitor type.
|
11808
|
+
description: The monitor type.
|
11809
|
+
type: string
|
11810
|
+
type: object
|
11811
|
+
MonthlyCostAttributionAttributes:
|
11812
|
+
description: Cost Attribution by Tag for a given organization.
|
11813
|
+
properties:
|
11814
|
+
month:
|
11815
|
+
description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`.'
|
11816
|
+
format: date-time
|
11817
|
+
type: string
|
11818
|
+
org_name:
|
11819
|
+
description: The name of the organization.
|
11820
|
+
type: string
|
11821
|
+
public_id:
|
11822
|
+
description: The organization public ID.
|
11823
|
+
type: string
|
11824
|
+
tag_config_source:
|
11825
|
+
description: The source of the cost attribution tag configuration and the
|
11826
|
+
selected tags in the format `<source_org_name>:::<selected tag 1>///<selected
|
11827
|
+
tag 2>///<selected tag 3>`.
|
11828
|
+
type: string
|
11829
|
+
tags:
|
11830
|
+
$ref: '#/components/schemas/CostAttributionTagNames'
|
11831
|
+
updated_at:
|
11832
|
+
description: Shows the most recent hour in the current months for all organizations
|
11833
|
+
for which all costs were calculated.
|
11834
|
+
type: string
|
11835
|
+
values:
|
11836
|
+
description: 'Fields in Cost Attribution by tag(s). Example: `infra_host_on_demand_cost`,
|
11837
|
+
`infra_host_committed_cost`, `infra_host_total_cost`, `infra_host_percentage_in_org`,
|
11838
|
+
`infra_host_percentage_in_account`.'
|
11839
|
+
type: object
|
11840
|
+
type: object
|
11841
|
+
MonthlyCostAttributionBody:
|
11842
|
+
description: Cost data.
|
11843
|
+
properties:
|
11844
|
+
attributes:
|
11845
|
+
$ref: '#/components/schemas/MonthlyCostAttributionAttributes'
|
11846
|
+
id:
|
11847
|
+
description: Unique ID of the response.
|
11848
|
+
type: string
|
11849
|
+
type:
|
11850
|
+
$ref: '#/components/schemas/CostAttributionType'
|
11851
|
+
type: object
|
11852
|
+
MonthlyCostAttributionMeta:
|
11853
|
+
description: The object containing document metadata.
|
11854
|
+
properties:
|
11855
|
+
aggregates:
|
11856
|
+
$ref: '#/components/schemas/CostAttributionAggregates'
|
11857
|
+
pagination:
|
11858
|
+
$ref: '#/components/schemas/MonthlyCostAttributionPagination'
|
11859
|
+
type: object
|
11860
|
+
MonthlyCostAttributionPagination:
|
11861
|
+
description: The metadata for the current pagination.
|
11862
|
+
properties:
|
11863
|
+
next_record_id:
|
11864
|
+
description: The cursor to use to get the next results, if any. To make
|
11865
|
+
the next request, use the same parameters with the addition of the `next_record_id`.
|
11866
|
+
nullable: true
|
10754
11867
|
type: string
|
10755
11868
|
type: object
|
11869
|
+
MonthlyCostAttributionResponse:
|
11870
|
+
description: Response containing the monthly cost attribution by tag(s).
|
11871
|
+
properties:
|
11872
|
+
data:
|
11873
|
+
description: Response containing cost attribution.
|
11874
|
+
items:
|
11875
|
+
$ref: '#/components/schemas/MonthlyCostAttributionBody'
|
11876
|
+
type: array
|
11877
|
+
meta:
|
11878
|
+
$ref: '#/components/schemas/MonthlyCostAttributionMeta'
|
11879
|
+
type: object
|
10756
11880
|
NullableRelationshipToUser:
|
10757
11881
|
description: Relationship to user.
|
11882
|
+
nullable: true
|
10758
11883
|
properties:
|
10759
11884
|
data:
|
10760
11885
|
$ref: '#/components/schemas/NullableRelationshipToUserData'
|
@@ -10775,6 +11900,141 @@ components:
|
|
10775
11900
|
- id
|
10776
11901
|
- type
|
10777
11902
|
type: object
|
11903
|
+
OktaAccount:
|
11904
|
+
description: Schema for an Okta account.
|
11905
|
+
properties:
|
11906
|
+
attributes:
|
11907
|
+
$ref: '#/components/schemas/OktaAccountAttributes'
|
11908
|
+
id:
|
11909
|
+
description: The ID of the Okta account, a UUID hash of the account name.
|
11910
|
+
example: f749daaf-682e-4208-a38d-c9b43162c609
|
11911
|
+
type: string
|
11912
|
+
type:
|
11913
|
+
$ref: '#/components/schemas/OktaAccountType'
|
11914
|
+
required:
|
11915
|
+
- attributes
|
11916
|
+
- type
|
11917
|
+
type: object
|
11918
|
+
OktaAccountAttributes:
|
11919
|
+
description: Attributes object for an Okta account.
|
11920
|
+
properties:
|
11921
|
+
api_key:
|
11922
|
+
description: The API key of the Okta account.
|
11923
|
+
type: string
|
11924
|
+
writeOnly: true
|
11925
|
+
auth_method:
|
11926
|
+
description: The authorization method for an Okta account.
|
11927
|
+
example: oauth
|
11928
|
+
type: string
|
11929
|
+
client_id:
|
11930
|
+
description: The Client ID of an Okta app integration.
|
11931
|
+
type: string
|
11932
|
+
client_secret:
|
11933
|
+
description: The client secret of an Okta app integration.
|
11934
|
+
type: string
|
11935
|
+
writeOnly: true
|
11936
|
+
domain:
|
11937
|
+
description: The domain of the Okta account.
|
11938
|
+
example: https://example.okta.com/
|
11939
|
+
type: string
|
11940
|
+
name:
|
11941
|
+
description: The name of the Okta account.
|
11942
|
+
example: Okta-Prod
|
11943
|
+
type: string
|
11944
|
+
required:
|
11945
|
+
- auth_method
|
11946
|
+
- domain
|
11947
|
+
- name
|
11948
|
+
type: object
|
11949
|
+
OktaAccountRequest:
|
11950
|
+
description: Request object for an Okta account.
|
11951
|
+
properties:
|
11952
|
+
data:
|
11953
|
+
$ref: '#/components/schemas/OktaAccount'
|
11954
|
+
required:
|
11955
|
+
- data
|
11956
|
+
type: object
|
11957
|
+
OktaAccountResponse:
|
11958
|
+
description: Response object for an Okta account.
|
11959
|
+
properties:
|
11960
|
+
data:
|
11961
|
+
$ref: '#/components/schemas/OktaAccount'
|
11962
|
+
type: object
|
11963
|
+
OktaAccountResponseData:
|
11964
|
+
description: Data object of an Okta account
|
11965
|
+
properties:
|
11966
|
+
attributes:
|
11967
|
+
$ref: '#/components/schemas/OktaAccountAttributes'
|
11968
|
+
id:
|
11969
|
+
description: The ID of the Okta account, a UUID hash of the account name.
|
11970
|
+
example: f749daaf-682e-4208-a38d-c9b43162c609
|
11971
|
+
type: string
|
11972
|
+
type:
|
11973
|
+
$ref: '#/components/schemas/OktaAccountType'
|
11974
|
+
required:
|
11975
|
+
- attributes
|
11976
|
+
- id
|
11977
|
+
- type
|
11978
|
+
type: object
|
11979
|
+
OktaAccountType:
|
11980
|
+
default: okta-accounts
|
11981
|
+
description: Account type for an Okta account.
|
11982
|
+
enum:
|
11983
|
+
- okta-accounts
|
11984
|
+
example: okta-accounts
|
11985
|
+
type: string
|
11986
|
+
x-enum-varnames:
|
11987
|
+
- OKTA_ACCOUNTS
|
11988
|
+
OktaAccountUpdateRequest:
|
11989
|
+
description: Payload schema when updating an Okta account.
|
11990
|
+
properties:
|
11991
|
+
data:
|
11992
|
+
$ref: '#/components/schemas/OktaAccountUpdateRequestData'
|
11993
|
+
required:
|
11994
|
+
- data
|
11995
|
+
type: object
|
11996
|
+
OktaAccountUpdateRequestAttributes:
|
11997
|
+
description: Attributes object for updating an Okta account.
|
11998
|
+
properties:
|
11999
|
+
api_key:
|
12000
|
+
description: The API key of the Okta account.
|
12001
|
+
type: string
|
12002
|
+
writeOnly: true
|
12003
|
+
auth_method:
|
12004
|
+
description: The authorization method for an Okta account.
|
12005
|
+
example: oauth
|
12006
|
+
type: string
|
12007
|
+
client_id:
|
12008
|
+
description: The Client ID of an Okta app integration.
|
12009
|
+
type: string
|
12010
|
+
client_secret:
|
12011
|
+
description: The client secret of an Okta app integration.
|
12012
|
+
type: string
|
12013
|
+
writeOnly: true
|
12014
|
+
domain:
|
12015
|
+
description: The domain associated with an Okta account.
|
12016
|
+
example: https://dev-test.okta.com/
|
12017
|
+
type: string
|
12018
|
+
required:
|
12019
|
+
- auth_method
|
12020
|
+
- domain
|
12021
|
+
type: object
|
12022
|
+
OktaAccountUpdateRequestData:
|
12023
|
+
description: Data object for updating an Okta account.
|
12024
|
+
properties:
|
12025
|
+
attributes:
|
12026
|
+
$ref: '#/components/schemas/OktaAccountUpdateRequestAttributes'
|
12027
|
+
type:
|
12028
|
+
$ref: '#/components/schemas/OktaAccountType'
|
12029
|
+
OktaAccountsResponse:
|
12030
|
+
description: The expected response schema when getting Okta accounts.
|
12031
|
+
properties:
|
12032
|
+
data:
|
12033
|
+
description: List of Okta accounts.
|
12034
|
+
items:
|
12035
|
+
$ref: '#/components/schemas/OktaAccountResponseData'
|
12036
|
+
type: array
|
12037
|
+
type: object
|
10778
12038
|
OnDemandConcurrencyCap:
|
10779
12039
|
description: On-demand concurrency cap.
|
10780
12040
|
properties:
|
@@ -11231,6 +12491,9 @@ components:
|
|
11231
12491
|
PartialAPIKeyAttributes:
|
11232
12492
|
description: Attributes of a partial API key.
|
11233
12493
|
properties:
|
12494
|
+
category:
|
12495
|
+
description: The category of the API key.
|
12496
|
+
type: string
|
11234
12497
|
created_at:
|
11235
12498
|
description: Creation date of the API key.
|
11236
12499
|
example: '2020-11-23T10:00:00.000Z'
|
@@ -11252,6 +12515,9 @@ components:
|
|
11252
12515
|
description: Name of the API key.
|
11253
12516
|
example: API Key for submitting metrics
|
11254
12517
|
type: string
|
12518
|
+
remote_config_read_enabled:
|
12519
|
+
description: The remote config read enabled status.
|
12520
|
+
type: boolean
|
11255
12521
|
type: object
|
11256
12522
|
PartialApplicationKey:
|
11257
12523
|
description: Partial Datadog application key.
|
@@ -11563,7 +12829,7 @@ components:
|
|
11563
12829
|
description: Powerpack relationship object.
|
11564
12830
|
properties:
|
11565
12831
|
author:
|
11566
|
-
$ref: '#/components/schemas/
|
12832
|
+
$ref: '#/components/schemas/RelationshipToUser'
|
11567
12833
|
type: object
|
11568
12834
|
PowerpackResponse:
|
11569
12835
|
description: Response object which includes a single powerpack configuration.
|
@@ -11635,6 +12901,7 @@ components:
|
|
11635
12901
|
last_offset:
|
11636
12902
|
description: The last offset.
|
11637
12903
|
format: int64
|
12904
|
+
nullable: true
|
11638
12905
|
type: integer
|
11639
12906
|
limit:
|
11640
12907
|
description: Pagination limit.
|
@@ -11747,6 +13014,62 @@ components:
|
|
11747
13014
|
type: string
|
11748
13015
|
x-enum-varnames:
|
11749
13016
|
- PROCESS
|
13017
|
+
ProjectedCost:
|
13018
|
+
description: Projected Cost data.
|
13019
|
+
properties:
|
13020
|
+
attributes:
|
13021
|
+
$ref: '#/components/schemas/ProjectedCostAttributes'
|
13022
|
+
id:
|
13023
|
+
description: Unique ID of the response.
|
13024
|
+
type: string
|
13025
|
+
type:
|
13026
|
+
$ref: '#/components/schemas/ProjectedCostType'
|
13027
|
+
type: object
|
13028
|
+
ProjectedCostAttributes:
|
13029
|
+
description: Projected Cost attributes data.
|
13030
|
+
properties:
|
13031
|
+
charges:
|
13032
|
+
description: List of charges data reported for the requested month.
|
13033
|
+
items:
|
13034
|
+
$ref: '#/components/schemas/ChargebackBreakdown'
|
13035
|
+
type: array
|
13036
|
+
date:
|
13037
|
+
description: The month requested.
|
13038
|
+
format: date-time
|
13039
|
+
type: string
|
13040
|
+
org_name:
|
13041
|
+
description: The organization name.
|
13042
|
+
type: string
|
13043
|
+
projected_total_cost:
|
13044
|
+
description: The total projected cost of products for the month.
|
13045
|
+
format: double
|
13046
|
+
type: number
|
13047
|
+
public_id:
|
13048
|
+
description: The organization public ID.
|
13049
|
+
type: string
|
13050
|
+
region:
|
13051
|
+
description: The region of the Datadog instance that the organization belongs
|
13052
|
+
to.
|
13053
|
+
type: string
|
13054
|
+
type: object
|
13055
|
+
ProjectedCostResponse:
|
13056
|
+
description: Projected Cost response.
|
13057
|
+
properties:
|
13058
|
+
data:
|
13059
|
+
description: Response containing Projected Cost.
|
13060
|
+
items:
|
13061
|
+
$ref: '#/components/schemas/ProjectedCost'
|
13062
|
+
type: array
|
13063
|
+
type: object
|
13064
|
+
ProjectedCostType:
|
13065
|
+
default: projected_cost
|
13066
|
+
description: Type of cost data.
|
13067
|
+
enum:
|
13068
|
+
- projected_cost
|
13069
|
+
example: projected_cost
|
13070
|
+
type: string
|
13071
|
+
x-enum-varnames:
|
13072
|
+
- PROJECt_COST
|
11750
13073
|
QueryFormula:
|
11751
13074
|
description: A formula for calculation based on one or more queries.
|
11752
13075
|
properties:
|
@@ -12559,6 +13882,30 @@ components:
|
|
12559
13882
|
- id
|
12560
13883
|
- type
|
12561
13884
|
type: object
|
13885
|
+
RelationshipToIncidentImpactData:
|
13886
|
+
description: Relationship to impact object.
|
13887
|
+
properties:
|
13888
|
+
id:
|
13889
|
+
description: A unique identifier that represents the impact.
|
13890
|
+
example: 00000000-0000-0000-2345-000000000000
|
13891
|
+
type: string
|
13892
|
+
type:
|
13893
|
+
$ref: '#/components/schemas/IncidentImpactsType'
|
13894
|
+
required:
|
13895
|
+
- id
|
13896
|
+
- type
|
13897
|
+
type: object
|
13898
|
+
RelationshipToIncidentImpacts:
|
13899
|
+
description: Relationship to impacts.
|
13900
|
+
properties:
|
13901
|
+
data:
|
13902
|
+
description: An array of incident impacts.
|
13903
|
+
items:
|
13904
|
+
$ref: '#/components/schemas/RelationshipToIncidentImpactData'
|
13905
|
+
type: array
|
13906
|
+
required:
|
13907
|
+
- data
|
13908
|
+
type: object
|
12562
13909
|
RelationshipToIncidentIntegrationMetadataData:
|
12563
13910
|
description: A relationship reference for an integration metadata object.
|
12564
13911
|
example:
|
@@ -12625,6 +13972,54 @@ components:
|
|
12625
13972
|
- id
|
12626
13973
|
- type
|
12627
13974
|
type: object
|
13975
|
+
RelationshipToIncidentResponderData:
|
13976
|
+
description: Relationship to impact object.
|
13977
|
+
properties:
|
13978
|
+
id:
|
13979
|
+
description: A unique identifier that represents the responder.
|
13980
|
+
example: 00000000-0000-0000-2345-000000000000
|
13981
|
+
type: string
|
13982
|
+
type:
|
13983
|
+
$ref: '#/components/schemas/IncidentRespondersType'
|
13984
|
+
required:
|
13985
|
+
- id
|
13986
|
+
- type
|
13987
|
+
type: object
|
13988
|
+
RelationshipToIncidentResponders:
|
13989
|
+
description: Relationship to incident responders.
|
13990
|
+
properties:
|
13991
|
+
data:
|
13992
|
+
description: An array of incident responders.
|
13993
|
+
items:
|
13994
|
+
$ref: '#/components/schemas/RelationshipToIncidentResponderData'
|
13995
|
+
type: array
|
13996
|
+
required:
|
13997
|
+
- data
|
13998
|
+
type: object
|
13999
|
+
RelationshipToIncidentUserDefinedFieldData:
|
14000
|
+
description: Relationship to impact object.
|
14001
|
+
properties:
|
14002
|
+
id:
|
14003
|
+
description: A unique identifier that represents the responder.
|
14004
|
+
example: 00000000-0000-0000-2345-000000000000
|
14005
|
+
type: string
|
14006
|
+
type:
|
14007
|
+
$ref: '#/components/schemas/IncidentUserDefinedFieldType'
|
14008
|
+
required:
|
14009
|
+
- id
|
14010
|
+
- type
|
14011
|
+
type: object
|
14012
|
+
RelationshipToIncidentUserDefinedFields:
|
14013
|
+
description: Relationship to incident user defined fields.
|
14014
|
+
properties:
|
14015
|
+
data:
|
14016
|
+
description: An array of user defined fields.
|
14017
|
+
items:
|
14018
|
+
$ref: '#/components/schemas/RelationshipToIncidentUserDefinedFieldData'
|
14019
|
+
type: array
|
14020
|
+
required:
|
14021
|
+
- data
|
14022
|
+
type: object
|
12628
14023
|
RelationshipToOrganization:
|
12629
14024
|
description: Relationship to an organization.
|
12630
14025
|
properties:
|
@@ -12831,6 +14226,27 @@ components:
|
|
12831
14226
|
- id
|
12832
14227
|
- type
|
12833
14228
|
type: object
|
14229
|
+
RelationshipToUserTeamTeam:
|
14230
|
+
description: Relationship between team membership and team
|
14231
|
+
properties:
|
14232
|
+
data:
|
14233
|
+
$ref: '#/components/schemas/RelationshipToUserTeamTeamData'
|
14234
|
+
required:
|
14235
|
+
- data
|
14236
|
+
type: object
|
14237
|
+
RelationshipToUserTeamTeamData:
|
14238
|
+
description: The team associated with the membership
|
14239
|
+
properties:
|
14240
|
+
id:
|
14241
|
+
description: The ID of the team associated with the membership
|
14242
|
+
example: d7e15d9d-d346-43da-81d8-3d9e71d9a5e9
|
14243
|
+
type: string
|
14244
|
+
type:
|
14245
|
+
$ref: '#/components/schemas/UserTeamTeamType'
|
14246
|
+
required:
|
14247
|
+
- id
|
14248
|
+
- type
|
14249
|
+
type: object
|
12834
14250
|
RelationshipToUserTeamUser:
|
12835
14251
|
description: Relationship between team membership and user
|
12836
14252
|
properties:
|
@@ -14248,6 +15664,8 @@ components:
|
|
14248
15664
|
$ref: '#/components/schemas/SecurityMonitoringRuleMaxSignalDuration'
|
14249
15665
|
newValueOptions:
|
14250
15666
|
$ref: '#/components/schemas/SecurityMonitoringRuleNewValueOptions'
|
15667
|
+
thirdPartyRuleOptions:
|
15668
|
+
$ref: '#/components/schemas/SecurityMonitoringRuleThirdPartyOptions'
|
14251
15669
|
type: object
|
14252
15670
|
SecurityMonitoringRuleQuery:
|
14253
15671
|
description: Query for matching rule.
|
@@ -14296,13 +15714,39 @@ components:
|
|
14296
15714
|
- MEDIUM
|
14297
15715
|
- HIGH
|
14298
15716
|
- CRITICAL
|
15717
|
+
SecurityMonitoringRuleThirdPartyOptions:
|
15718
|
+
description: Options on third party rules.
|
15719
|
+
properties:
|
15720
|
+
defaultNotifications:
|
15721
|
+
description: Notification targets for the logs that do not correspond to
|
15722
|
+
any of the cases.
|
15723
|
+
items:
|
15724
|
+
description: Notification.
|
15725
|
+
type: string
|
15726
|
+
type: array
|
15727
|
+
defaultStatus:
|
15728
|
+
$ref: '#/components/schemas/SecurityMonitoringRuleSeverity'
|
15729
|
+
rootQueries:
|
15730
|
+
description: Queries to be combined with third party case queries. Each
|
15731
|
+
of them can have different group by fields, to aggregate differently based
|
15732
|
+
on the type of alert.
|
15733
|
+
items:
|
15734
|
+
$ref: '#/components/schemas/SecurityMonitoringThirdPartyRootQuery'
|
15735
|
+
type: array
|
15736
|
+
signalTitleTemplate:
|
15737
|
+
description: A template for the signal title; if omitted, the title is generated
|
15738
|
+
based on the case name.
|
15739
|
+
type: string
|
15740
|
+
type: object
|
14299
15741
|
SecurityMonitoringRuleTypeCreate:
|
14300
15742
|
description: The rule type.
|
14301
15743
|
enum:
|
15744
|
+
- application_security
|
14302
15745
|
- log_detection
|
14303
15746
|
- workload_security
|
14304
15747
|
type: string
|
14305
15748
|
x-enum-varnames:
|
15749
|
+
- APPLICATION_SECURITY
|
14306
15750
|
- LOG_DETECTION
|
14307
15751
|
- WORKLOAD_SECURITY
|
14308
15752
|
SecurityMonitoringRuleTypeRead:
|
@@ -14363,6 +15807,13 @@ components:
|
|
14363
15807
|
description: Tag.
|
14364
15808
|
type: string
|
14365
15809
|
type: array
|
15810
|
+
thirdPartyCases:
|
15811
|
+
description: Cases for generating signals from third party rules. Only available
|
15812
|
+
for third party rules.
|
15813
|
+
example: []
|
15814
|
+
items:
|
15815
|
+
$ref: '#/components/schemas/SecurityMonitoringThirdPartyRuleCase'
|
15816
|
+
type: array
|
14366
15817
|
version:
|
14367
15818
|
description: The version of the rule being updated.
|
14368
15819
|
example: 1
|
@@ -14992,6 +16443,13 @@ components:
|
|
14992
16443
|
description: Tag.
|
14993
16444
|
type: string
|
14994
16445
|
type: array
|
16446
|
+
thirdPartyCases:
|
16447
|
+
description: Cases for generating signals from third party rules. Only available
|
16448
|
+
for third party rules.
|
16449
|
+
example: []
|
16450
|
+
items:
|
16451
|
+
$ref: '#/components/schemas/SecurityMonitoringThirdPartyRuleCaseCreate'
|
16452
|
+
type: array
|
14995
16453
|
type:
|
14996
16454
|
$ref: '#/components/schemas/SecurityMonitoringRuleTypeCreate'
|
14997
16455
|
required:
|
@@ -15100,29 +16558,88 @@ components:
|
|
15100
16558
|
name:
|
15101
16559
|
description: The name of the rule.
|
15102
16560
|
type: string
|
15103
|
-
options:
|
15104
|
-
$ref: '#/components/schemas/SecurityMonitoringRuleOptions'
|
15105
|
-
queries:
|
15106
|
-
description: Queries for selecting logs which are part of the rule.
|
16561
|
+
options:
|
16562
|
+
$ref: '#/components/schemas/SecurityMonitoringRuleOptions'
|
16563
|
+
queries:
|
16564
|
+
description: Queries for selecting logs which are part of the rule.
|
16565
|
+
items:
|
16566
|
+
$ref: '#/components/schemas/SecurityMonitoringStandardRuleQuery'
|
16567
|
+
type: array
|
16568
|
+
tags:
|
16569
|
+
description: Tags for generated signals.
|
16570
|
+
items:
|
16571
|
+
description: Tag.
|
16572
|
+
type: string
|
16573
|
+
type: array
|
16574
|
+
thirdPartyCases:
|
16575
|
+
description: Cases for generating signals from third party rules. Only available
|
16576
|
+
for third party rules.
|
16577
|
+
example: []
|
16578
|
+
items:
|
16579
|
+
$ref: '#/components/schemas/SecurityMonitoringThirdPartyRuleCase'
|
16580
|
+
type: array
|
16581
|
+
type:
|
16582
|
+
$ref: '#/components/schemas/SecurityMonitoringRuleTypeRead'
|
16583
|
+
updateAuthorId:
|
16584
|
+
description: User ID of the user who updated the rule.
|
16585
|
+
format: int64
|
16586
|
+
type: integer
|
16587
|
+
version:
|
16588
|
+
description: The version of the rule.
|
16589
|
+
format: int64
|
16590
|
+
type: integer
|
16591
|
+
SecurityMonitoringThirdPartyRootQuery:
|
16592
|
+
description: A query to be combined with the third party case query.
|
16593
|
+
properties:
|
16594
|
+
groupByFields:
|
16595
|
+
description: Fields to group by.
|
16596
|
+
items:
|
16597
|
+
description: Field.
|
16598
|
+
type: string
|
16599
|
+
type: array
|
16600
|
+
query:
|
16601
|
+
description: Query to run on logs.
|
16602
|
+
example: source:cloudtrail
|
16603
|
+
type: string
|
16604
|
+
type: object
|
16605
|
+
SecurityMonitoringThirdPartyRuleCase:
|
16606
|
+
description: Case when signal is generated by a third party rule.
|
16607
|
+
properties:
|
16608
|
+
name:
|
16609
|
+
description: Name of the case.
|
16610
|
+
type: string
|
16611
|
+
notifications:
|
16612
|
+
description: Notification targets for each rule case.
|
15107
16613
|
items:
|
15108
|
-
|
16614
|
+
description: Notification.
|
16615
|
+
type: string
|
15109
16616
|
type: array
|
15110
|
-
|
15111
|
-
description:
|
16617
|
+
query:
|
16618
|
+
description: A query to map a third party event to this case.
|
16619
|
+
type: string
|
16620
|
+
status:
|
16621
|
+
$ref: '#/components/schemas/SecurityMonitoringRuleSeverity'
|
16622
|
+
type: object
|
16623
|
+
SecurityMonitoringThirdPartyRuleCaseCreate:
|
16624
|
+
description: Case when a signal is generated by a third party rule.
|
16625
|
+
properties:
|
16626
|
+
name:
|
16627
|
+
description: Name of the case.
|
16628
|
+
type: string
|
16629
|
+
notifications:
|
16630
|
+
description: Notification targets for each rule case.
|
15112
16631
|
items:
|
15113
|
-
description:
|
16632
|
+
description: Notification.
|
15114
16633
|
type: string
|
15115
16634
|
type: array
|
15116
|
-
|
15117
|
-
|
15118
|
-
|
15119
|
-
|
15120
|
-
|
15121
|
-
|
15122
|
-
|
15123
|
-
|
15124
|
-
format: int64
|
15125
|
-
type: integer
|
16635
|
+
query:
|
16636
|
+
description: A query to map a third party event to this case.
|
16637
|
+
type: string
|
16638
|
+
status:
|
16639
|
+
$ref: '#/components/schemas/SecurityMonitoringRuleSeverity'
|
16640
|
+
required:
|
16641
|
+
- status
|
16642
|
+
type: object
|
15126
16643
|
SecurityMonitoringTriageUser:
|
15127
16644
|
description: Object representing a given user entity.
|
15128
16645
|
properties:
|
@@ -15409,6 +16926,44 @@ components:
|
|
15409
16926
|
meta:
|
15410
16927
|
$ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly'
|
15411
16928
|
type: object
|
16929
|
+
SensitiveDataScannerIncludedKeywordConfiguration:
|
16930
|
+
description: 'Object defining a set of keywords and a number of characters that
|
16931
|
+
help reduce noise.
|
16932
|
+
|
16933
|
+
You can provide a list of keywords you would like to check within a defined
|
16934
|
+
proximity of the matching pattern.
|
16935
|
+
|
16936
|
+
If any of the keywords are found within the proximity check, the match is
|
16937
|
+
kept.
|
16938
|
+
|
16939
|
+
If none are found, the match is discarded.'
|
16940
|
+
properties:
|
16941
|
+
character_count:
|
16942
|
+
description: 'The number of characters behind a match detected by Sensitive
|
16943
|
+
Data Scanner to look for the keywords defined.
|
16944
|
+
|
16945
|
+
`character_count` should be greater than the maximum length of a keyword
|
16946
|
+
defined for a rule.'
|
16947
|
+
example: 30
|
16948
|
+
format: int64
|
16949
|
+
maximum: 50
|
16950
|
+
minimum: 1
|
16951
|
+
type: integer
|
16952
|
+
keywords:
|
16953
|
+
description: 'Keyword list that will be checked during scanning in order
|
16954
|
+
to validate a match.
|
16955
|
+
|
16956
|
+
The number of keywords in the list must be less than or equal to 20.'
|
16957
|
+
example:
|
16958
|
+
- credit card
|
16959
|
+
- cc
|
16960
|
+
items:
|
16961
|
+
type: string
|
16962
|
+
type: array
|
16963
|
+
required:
|
16964
|
+
- keywords
|
16965
|
+
- character_count
|
16966
|
+
type: object
|
15412
16967
|
SensitiveDataScannerMeta:
|
15413
16968
|
description: Meta response containing information about the API.
|
15414
16969
|
properties:
|
@@ -15502,6 +17057,8 @@ components:
|
|
15502
17057
|
items:
|
15503
17058
|
type: string
|
15504
17059
|
type: array
|
17060
|
+
included_keyword_configuration:
|
17061
|
+
$ref: '#/components/schemas/SensitiveDataScannerIncludedKeywordConfiguration'
|
15505
17062
|
is_enabled:
|
15506
17063
|
description: Whether or not the rule is enabled.
|
15507
17064
|
type: boolean
|
@@ -15521,6 +17078,12 @@ components:
|
|
15521
17078
|
pattern:
|
15522
17079
|
description: Not included if there is a relationship to a standard pattern.
|
15523
17080
|
type: string
|
17081
|
+
priority:
|
17082
|
+
description: Integer from 1 (high) to 5 (low) indicating rule issue severity.
|
17083
|
+
format: int64
|
17084
|
+
maximum: 5
|
17085
|
+
minimum: 1
|
17086
|
+
type: integer
|
15524
17087
|
tags:
|
15525
17088
|
description: List of tags.
|
15526
17089
|
items:
|
@@ -15665,12 +17228,24 @@ components:
|
|
15665
17228
|
description:
|
15666
17229
|
description: Description of the standard pattern.
|
15667
17230
|
type: string
|
17231
|
+
included_keywords:
|
17232
|
+
description: List of included keywords.
|
17233
|
+
items:
|
17234
|
+
type: string
|
17235
|
+
type: array
|
15668
17236
|
name:
|
15669
17237
|
description: Name of the standard pattern.
|
15670
17238
|
type: string
|
15671
17239
|
pattern:
|
15672
17240
|
description: Regex to match.
|
15673
17241
|
type: string
|
17242
|
+
priority:
|
17243
|
+
description: Integer from 1 (high) to 5 (low) indicating standard pattern
|
17244
|
+
issue severity.
|
17245
|
+
format: int64
|
17246
|
+
maximum: 5
|
17247
|
+
minimum: 1
|
17248
|
+
type: integer
|
15674
17249
|
tags:
|
15675
17250
|
description: List of tags.
|
15676
17251
|
items:
|
@@ -16788,6 +18363,16 @@ components:
|
|
16788
18363
|
- channel_name
|
16789
18364
|
- redirect_url
|
16790
18365
|
type: object
|
18366
|
+
SortDirection:
|
18367
|
+
default: desc
|
18368
|
+
description: The direction to sort by.
|
18369
|
+
enum:
|
18370
|
+
- desc
|
18371
|
+
- asc
|
18372
|
+
type: string
|
18373
|
+
x-enum-varnames:
|
18374
|
+
- DESC
|
18375
|
+
- ASC
|
16791
18376
|
Span:
|
16792
18377
|
description: Object description of a spans after being processed and stored
|
16793
18378
|
by Datadog.
|
@@ -18775,6 +20360,20 @@ components:
|
|
18775
20360
|
UserTeamAttributes:
|
18776
20361
|
description: Team membership attributes
|
18777
20362
|
properties:
|
20363
|
+
provisioned_by:
|
20364
|
+
description: 'The mechanism responsible for provisioning the team relationship.
|
20365
|
+
|
20366
|
+
Possible values: null for added by a user, "service_account" if added
|
20367
|
+
by a service account, and "saml_mapping" if provisioned via SAML mapping.'
|
20368
|
+
nullable: true
|
20369
|
+
readOnly: true
|
20370
|
+
type: string
|
20371
|
+
provisioned_by_id:
|
20372
|
+
description: UUID of the User or Service Account who provisioned this team
|
20373
|
+
membership, or null if provisioned via SAML mapping.
|
20374
|
+
nullable: true
|
20375
|
+
readOnly: true
|
20376
|
+
type: string
|
18778
20377
|
role:
|
18779
20378
|
$ref: '#/components/schemas/UserTeamRole'
|
18780
20379
|
type: object
|
@@ -18826,6 +20425,8 @@ components:
|
|
18826
20425
|
UserTeamRelationships:
|
18827
20426
|
description: Relationship between membership and a user
|
18828
20427
|
properties:
|
20428
|
+
team:
|
20429
|
+
$ref: '#/components/schemas/RelationshipToUserTeamTeam'
|
18829
20430
|
user:
|
18830
20431
|
$ref: '#/components/schemas/RelationshipToUserTeamUser'
|
18831
20432
|
type: object
|
@@ -18851,6 +20452,15 @@ components:
|
|
18851
20452
|
type: string
|
18852
20453
|
x-enum-varnames:
|
18853
20454
|
- ADMIN
|
20455
|
+
UserTeamTeamType:
|
20456
|
+
default: team
|
20457
|
+
description: User team team type
|
20458
|
+
enum:
|
20459
|
+
- team
|
20460
|
+
example: team
|
20461
|
+
type: string
|
20462
|
+
x-enum-varnames:
|
20463
|
+
- TEAM
|
18854
20464
|
UserTeamType:
|
18855
20465
|
default: team_memberships
|
18856
20466
|
description: Team membership type
|
@@ -19028,7 +20638,7 @@ components:
|
|
19028
20638
|
an organization. Mute and unmute hosts. The ability to write monitors
|
19029
20639
|
is not required to set downtimes.
|
19030
20640
|
monitors_read: View monitors.
|
19031
|
-
monitors_write: Edit
|
20641
|
+
monitors_write: Edit and delete individual monitors.
|
19032
20642
|
security_monitoring_filters_read: Read Security Filters.
|
19033
20643
|
security_monitoring_filters_write: Create, edit, and delete Security Filters.
|
19034
20644
|
security_monitoring_findings_read: View CSPM Findings.
|
@@ -20059,52 +21669,209 @@ paths:
|
|
20059
21669
|
content:
|
20060
21670
|
application/json:
|
20061
21671
|
schema:
|
20062
|
-
$ref: '#/components/schemas/HTTPCIAppErrors'
|
20063
|
-
description: Payload Too Large
|
21672
|
+
$ref: '#/components/schemas/HTTPCIAppErrors'
|
21673
|
+
description: Payload Too Large
|
21674
|
+
'429':
|
21675
|
+
content:
|
21676
|
+
application/json:
|
21677
|
+
schema:
|
21678
|
+
$ref: '#/components/schemas/HTTPCIAppErrors'
|
21679
|
+
description: Too Many Requests
|
21680
|
+
'500':
|
21681
|
+
content:
|
21682
|
+
application/json:
|
21683
|
+
schema:
|
21684
|
+
$ref: '#/components/schemas/HTTPCIAppErrors'
|
21685
|
+
description: Internal Server Error
|
21686
|
+
'503':
|
21687
|
+
content:
|
21688
|
+
application/json:
|
21689
|
+
schema:
|
21690
|
+
$ref: '#/components/schemas/HTTPCIAppErrors'
|
21691
|
+
description: Service Unavailable
|
21692
|
+
security:
|
21693
|
+
- apiKeyAuth: []
|
21694
|
+
summary: Send pipeline event
|
21695
|
+
tags:
|
21696
|
+
- CI Visibility Pipelines
|
21697
|
+
x-codegen-request-body-name: body
|
21698
|
+
/api/v2/ci/pipelines/analytics/aggregate:
|
21699
|
+
post:
|
21700
|
+
description: Use this API endpoint to aggregate CI Visibility pipeline events
|
21701
|
+
into buckets of computed metrics and timeseries.
|
21702
|
+
operationId: AggregateCIAppPipelineEvents
|
21703
|
+
requestBody:
|
21704
|
+
content:
|
21705
|
+
application/json:
|
21706
|
+
schema:
|
21707
|
+
$ref: '#/components/schemas/CIAppPipelinesAggregateRequest'
|
21708
|
+
required: true
|
21709
|
+
responses:
|
21710
|
+
'200':
|
21711
|
+
content:
|
21712
|
+
application/json:
|
21713
|
+
schema:
|
21714
|
+
$ref: '#/components/schemas/CIAppPipelinesAnalyticsAggregateResponse'
|
21715
|
+
description: OK
|
21716
|
+
'400':
|
21717
|
+
$ref: '#/components/responses/BadRequestResponse'
|
21718
|
+
'403':
|
21719
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
21720
|
+
'429':
|
21721
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
21722
|
+
security:
|
21723
|
+
- apiKeyAuth: []
|
21724
|
+
appKeyAuth: []
|
21725
|
+
- AuthZ:
|
21726
|
+
- ci_visibility_read
|
21727
|
+
summary: Aggregate pipelines events
|
21728
|
+
tags:
|
21729
|
+
- CI Visibility Pipelines
|
21730
|
+
x-codegen-request-body-name: body
|
21731
|
+
/api/v2/ci/pipelines/events:
|
21732
|
+
get:
|
21733
|
+
description: 'List endpoint returns CI Visibility pipeline events that match
|
21734
|
+
a [search query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/).
|
21735
|
+
|
21736
|
+
[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).
|
21737
|
+
|
21738
|
+
|
21739
|
+
Use this endpoint to see your latest pipeline events.'
|
21740
|
+
operationId: ListCIAppPipelineEvents
|
21741
|
+
parameters:
|
21742
|
+
- description: Search query following log syntax.
|
21743
|
+
example: '@ci.provider.name:github @ci.pipeline.name:Pull Request Labeler'
|
21744
|
+
in: query
|
21745
|
+
name: filter[query]
|
21746
|
+
required: false
|
21747
|
+
schema:
|
21748
|
+
type: string
|
21749
|
+
- description: Minimum timestamp for requested events.
|
21750
|
+
example: '2019-01-02T09:42:36.320Z'
|
21751
|
+
in: query
|
21752
|
+
name: filter[from]
|
21753
|
+
required: false
|
21754
|
+
schema:
|
21755
|
+
format: date-time
|
21756
|
+
type: string
|
21757
|
+
- description: Maximum timestamp for requested events.
|
21758
|
+
example: '2019-01-03T09:42:36.320Z'
|
21759
|
+
in: query
|
21760
|
+
name: filter[to]
|
21761
|
+
required: false
|
21762
|
+
schema:
|
21763
|
+
format: date-time
|
21764
|
+
type: string
|
21765
|
+
- description: Order of events in results.
|
21766
|
+
in: query
|
21767
|
+
name: sort
|
21768
|
+
required: false
|
21769
|
+
schema:
|
21770
|
+
$ref: '#/components/schemas/CIAppSort'
|
21771
|
+
- description: List following results with a cursor provided in the previous
|
21772
|
+
query.
|
21773
|
+
example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==
|
21774
|
+
in: query
|
21775
|
+
name: page[cursor]
|
21776
|
+
required: false
|
21777
|
+
schema:
|
21778
|
+
type: string
|
21779
|
+
- description: Maximum number of events in the response.
|
21780
|
+
example: 25
|
21781
|
+
in: query
|
21782
|
+
name: page[limit]
|
21783
|
+
required: false
|
21784
|
+
schema:
|
21785
|
+
default: 10
|
21786
|
+
format: int32
|
21787
|
+
maximum: 1000
|
21788
|
+
type: integer
|
21789
|
+
responses:
|
21790
|
+
'200':
|
21791
|
+
content:
|
21792
|
+
application/json:
|
21793
|
+
schema:
|
21794
|
+
$ref: '#/components/schemas/CIAppPipelineEventsResponse'
|
21795
|
+
description: OK
|
21796
|
+
'400':
|
21797
|
+
$ref: '#/components/responses/BadRequestResponse'
|
21798
|
+
'403':
|
21799
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
21800
|
+
'429':
|
21801
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
21802
|
+
security:
|
21803
|
+
- apiKeyAuth: []
|
21804
|
+
appKeyAuth: []
|
21805
|
+
- AuthZ:
|
21806
|
+
- ci_visibility_read
|
21807
|
+
summary: Get a list of pipelines events
|
21808
|
+
tags:
|
21809
|
+
- CI Visibility Pipelines
|
21810
|
+
x-pagination:
|
21811
|
+
cursorParam: page[cursor]
|
21812
|
+
cursorPath: meta.page.after
|
21813
|
+
limitParam: page[limit]
|
21814
|
+
resultsPath: data
|
21815
|
+
/api/v2/ci/pipelines/events/search:
|
21816
|
+
post:
|
21817
|
+
description: 'List endpoint returns CI Visibility pipeline events that match
|
21818
|
+
a [search query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/).
|
21819
|
+
|
21820
|
+
[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).
|
21821
|
+
|
21822
|
+
|
21823
|
+
Use this endpoint to build complex events filtering and search.'
|
21824
|
+
operationId: SearchCIAppPipelineEvents
|
21825
|
+
requestBody:
|
21826
|
+
content:
|
21827
|
+
application/json:
|
21828
|
+
schema:
|
21829
|
+
$ref: '#/components/schemas/CIAppPipelineEventsRequest'
|
21830
|
+
required: false
|
21831
|
+
responses:
|
21832
|
+
'200':
|
21833
|
+
content:
|
21834
|
+
application/json:
|
21835
|
+
schema:
|
21836
|
+
$ref: '#/components/schemas/CIAppPipelineEventsResponse'
|
21837
|
+
description: OK
|
21838
|
+
'400':
|
21839
|
+
$ref: '#/components/responses/BadRequestResponse'
|
21840
|
+
'403':
|
21841
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
20064
21842
|
'429':
|
20065
|
-
|
20066
|
-
application/json:
|
20067
|
-
schema:
|
20068
|
-
$ref: '#/components/schemas/HTTPCIAppErrors'
|
20069
|
-
description: Too Many Requests
|
20070
|
-
'500':
|
20071
|
-
content:
|
20072
|
-
application/json:
|
20073
|
-
schema:
|
20074
|
-
$ref: '#/components/schemas/HTTPCIAppErrors'
|
20075
|
-
description: Internal Server Error
|
20076
|
-
'503':
|
20077
|
-
content:
|
20078
|
-
application/json:
|
20079
|
-
schema:
|
20080
|
-
$ref: '#/components/schemas/HTTPCIAppErrors'
|
20081
|
-
description: Service Unavailable
|
21843
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
20082
21844
|
security:
|
20083
21845
|
- apiKeyAuth: []
|
20084
|
-
|
21846
|
+
appKeyAuth: []
|
21847
|
+
- AuthZ:
|
21848
|
+
- ci_visibility_read
|
21849
|
+
summary: Search pipelines events
|
20085
21850
|
tags:
|
20086
21851
|
- CI Visibility Pipelines
|
20087
21852
|
x-codegen-request-body-name: body
|
20088
|
-
x-
|
20089
|
-
|
20090
|
-
|
20091
|
-
|
21853
|
+
x-pagination:
|
21854
|
+
cursorParam: body.page.cursor
|
21855
|
+
cursorPath: meta.page.after
|
21856
|
+
limitParam: body.page.limit
|
21857
|
+
resultsPath: data
|
21858
|
+
/api/v2/ci/tests/analytics/aggregate:
|
20092
21859
|
post:
|
20093
|
-
description:
|
20094
|
-
|
20095
|
-
operationId:
|
21860
|
+
description: The API endpoint to aggregate CI Visibility test events into buckets
|
21861
|
+
of computed metrics and timeseries.
|
21862
|
+
operationId: AggregateCIAppTestEvents
|
20096
21863
|
requestBody:
|
20097
21864
|
content:
|
20098
21865
|
application/json:
|
20099
21866
|
schema:
|
20100
|
-
$ref: '#/components/schemas/
|
21867
|
+
$ref: '#/components/schemas/CIAppTestsAggregateRequest'
|
20101
21868
|
required: true
|
20102
21869
|
responses:
|
20103
21870
|
'200':
|
20104
21871
|
content:
|
20105
21872
|
application/json:
|
20106
21873
|
schema:
|
20107
|
-
$ref: '#/components/schemas/
|
21874
|
+
$ref: '#/components/schemas/CIAppTestsAnalyticsAggregateResponse'
|
20108
21875
|
description: OK
|
20109
21876
|
'400':
|
20110
21877
|
$ref: '#/components/responses/BadRequestResponse'
|
@@ -20117,23 +21884,23 @@ paths:
|
|
20117
21884
|
appKeyAuth: []
|
20118
21885
|
- AuthZ:
|
20119
21886
|
- ci_visibility_read
|
20120
|
-
summary: Aggregate
|
21887
|
+
summary: Aggregate tests events
|
20121
21888
|
tags:
|
20122
|
-
- CI Visibility
|
21889
|
+
- CI Visibility Tests
|
20123
21890
|
x-codegen-request-body-name: body
|
20124
|
-
/api/v2/ci/
|
21891
|
+
/api/v2/ci/tests/events:
|
20125
21892
|
get:
|
20126
|
-
description: 'List endpoint returns CI Visibility
|
20127
|
-
|
21893
|
+
description: 'List endpoint returns CI Visibility test events that match a [log
|
21894
|
+
search query](https://docs.datadoghq.com/logs/explorer/search_syntax/).
|
20128
21895
|
|
20129
21896
|
[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).
|
20130
21897
|
|
20131
21898
|
|
20132
|
-
Use this endpoint to see your latest
|
20133
|
-
operationId:
|
21899
|
+
Use this endpoint to see your latest test events.'
|
21900
|
+
operationId: ListCIAppTestEvents
|
20134
21901
|
parameters:
|
20135
21902
|
- description: Search query following log syntax.
|
20136
|
-
example: '@
|
21903
|
+
example: '@test.name:test_foo @test.suite:github.com/DataDog/dd-go/model'
|
20137
21904
|
in: query
|
20138
21905
|
name: filter[query]
|
20139
21906
|
required: false
|
@@ -20153,418 +21920,738 @@ paths:
|
|
20153
21920
|
name: filter[to]
|
20154
21921
|
required: false
|
20155
21922
|
schema:
|
20156
|
-
format: date-time
|
21923
|
+
format: date-time
|
21924
|
+
type: string
|
21925
|
+
- description: Order of events in results.
|
21926
|
+
in: query
|
21927
|
+
name: sort
|
21928
|
+
required: false
|
21929
|
+
schema:
|
21930
|
+
$ref: '#/components/schemas/CIAppSort'
|
21931
|
+
- description: List following results with a cursor provided in the previous
|
21932
|
+
query.
|
21933
|
+
example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==
|
21934
|
+
in: query
|
21935
|
+
name: page[cursor]
|
21936
|
+
required: false
|
21937
|
+
schema:
|
21938
|
+
type: string
|
21939
|
+
- description: Maximum number of events in the response.
|
21940
|
+
example: 25
|
21941
|
+
in: query
|
21942
|
+
name: page[limit]
|
21943
|
+
required: false
|
21944
|
+
schema:
|
21945
|
+
default: 10
|
21946
|
+
format: int32
|
21947
|
+
maximum: 1000
|
21948
|
+
type: integer
|
21949
|
+
responses:
|
21950
|
+
'200':
|
21951
|
+
content:
|
21952
|
+
application/json:
|
21953
|
+
schema:
|
21954
|
+
$ref: '#/components/schemas/CIAppTestEventsResponse'
|
21955
|
+
description: OK
|
21956
|
+
'400':
|
21957
|
+
$ref: '#/components/responses/BadRequestResponse'
|
21958
|
+
'403':
|
21959
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
21960
|
+
'429':
|
21961
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
21962
|
+
security:
|
21963
|
+
- apiKeyAuth: []
|
21964
|
+
appKeyAuth: []
|
21965
|
+
- AuthZ:
|
21966
|
+
- ci_visibility_read
|
21967
|
+
summary: Get a list of tests events
|
21968
|
+
tags:
|
21969
|
+
- CI Visibility Tests
|
21970
|
+
x-pagination:
|
21971
|
+
cursorParam: page[cursor]
|
21972
|
+
cursorPath: meta.page.after
|
21973
|
+
limitParam: page[limit]
|
21974
|
+
resultsPath: data
|
21975
|
+
/api/v2/ci/tests/events/search:
|
21976
|
+
post:
|
21977
|
+
description: 'List endpoint returns CI Visibility test events that match a [log
|
21978
|
+
search query](https://docs.datadoghq.com/logs/explorer/search_syntax/).
|
21979
|
+
|
21980
|
+
[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).
|
21981
|
+
|
21982
|
+
|
21983
|
+
Use this endpoint to build complex events filtering and search.'
|
21984
|
+
operationId: SearchCIAppTestEvents
|
21985
|
+
requestBody:
|
21986
|
+
content:
|
21987
|
+
application/json:
|
21988
|
+
schema:
|
21989
|
+
$ref: '#/components/schemas/CIAppTestEventsRequest'
|
21990
|
+
required: false
|
21991
|
+
responses:
|
21992
|
+
'200':
|
21993
|
+
content:
|
21994
|
+
application/json:
|
21995
|
+
schema:
|
21996
|
+
$ref: '#/components/schemas/CIAppTestEventsResponse'
|
21997
|
+
description: OK
|
21998
|
+
'400':
|
21999
|
+
$ref: '#/components/responses/BadRequestResponse'
|
22000
|
+
'403':
|
22001
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
22002
|
+
'429':
|
22003
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
22004
|
+
security:
|
22005
|
+
- apiKeyAuth: []
|
22006
|
+
appKeyAuth: []
|
22007
|
+
- AuthZ:
|
22008
|
+
- ci_visibility_read
|
22009
|
+
summary: Search tests events
|
22010
|
+
tags:
|
22011
|
+
- CI Visibility Tests
|
22012
|
+
x-codegen-request-body-name: body
|
22013
|
+
x-pagination:
|
22014
|
+
cursorParam: body.page.cursor
|
22015
|
+
cursorPath: meta.page.after
|
22016
|
+
limitParam: body.page.limit
|
22017
|
+
resultsPath: data
|
22018
|
+
/api/v2/container_images:
|
22019
|
+
get:
|
22020
|
+
description: Get all Container Images for your organization.
|
22021
|
+
operationId: ListContainerImages
|
22022
|
+
parameters:
|
22023
|
+
- description: Comma-separated list of tags to filter Container Images by.
|
22024
|
+
example: short_image:redis,status:running
|
22025
|
+
in: query
|
22026
|
+
name: filter[tags]
|
22027
|
+
required: false
|
22028
|
+
schema:
|
22029
|
+
type: string
|
22030
|
+
- description: Comma-separated list of tags to group Container Images by.
|
22031
|
+
example: registry,image_tags
|
22032
|
+
in: query
|
22033
|
+
name: group_by
|
22034
|
+
required: false
|
22035
|
+
schema:
|
22036
|
+
type: string
|
22037
|
+
- description: Attribute to sort Container Images by.
|
22038
|
+
example: container_count
|
22039
|
+
in: query
|
22040
|
+
name: sort
|
22041
|
+
required: false
|
22042
|
+
schema:
|
22043
|
+
type: string
|
22044
|
+
- description: Maximum number of results returned.
|
22045
|
+
in: query
|
22046
|
+
name: page[size]
|
22047
|
+
required: false
|
22048
|
+
schema:
|
22049
|
+
default: 1000
|
22050
|
+
format: int32
|
22051
|
+
maximum: 10000
|
22052
|
+
minimum: 1
|
22053
|
+
type: integer
|
22054
|
+
- description: 'String to query the next page of results.
|
22055
|
+
|
22056
|
+
This key is provided with each valid response from the API in `meta.pagination.next_cursor`.'
|
22057
|
+
in: query
|
22058
|
+
name: page[cursor]
|
22059
|
+
required: false
|
22060
|
+
schema:
|
22061
|
+
type: string
|
22062
|
+
responses:
|
22063
|
+
'200':
|
22064
|
+
content:
|
22065
|
+
application/json:
|
22066
|
+
schema:
|
22067
|
+
$ref: '#/components/schemas/ContainerImagesResponse'
|
22068
|
+
description: OK
|
22069
|
+
'400':
|
22070
|
+
content:
|
22071
|
+
application/json:
|
22072
|
+
schema:
|
22073
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
22074
|
+
description: Bad Request
|
22075
|
+
'403':
|
22076
|
+
content:
|
22077
|
+
application/json:
|
22078
|
+
schema:
|
22079
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
22080
|
+
description: Authentication Error
|
22081
|
+
'429':
|
22082
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
22083
|
+
security:
|
22084
|
+
- apiKeyAuth: []
|
22085
|
+
appKeyAuth: []
|
22086
|
+
- AuthZ: []
|
22087
|
+
summary: Get all Container Images
|
22088
|
+
tags:
|
22089
|
+
- Container Images
|
22090
|
+
x-pagination:
|
22091
|
+
cursorParam: page[cursor]
|
22092
|
+
cursorPath: meta.pagination.next_cursor
|
22093
|
+
limitParam: page[size]
|
22094
|
+
resultsPath: data
|
22095
|
+
/api/v2/containers:
|
22096
|
+
get:
|
22097
|
+
description: Get all containers for your organization.
|
22098
|
+
operationId: ListContainers
|
22099
|
+
parameters:
|
22100
|
+
- description: Comma-separated list of tags to filter containers by.
|
22101
|
+
example: env:prod,short_image:cassandra
|
22102
|
+
in: query
|
22103
|
+
name: filter[tags]
|
22104
|
+
required: false
|
22105
|
+
schema:
|
22106
|
+
type: string
|
22107
|
+
- description: Comma-separated list of tags to group containers by.
|
22108
|
+
example: datacenter,cluster
|
22109
|
+
in: query
|
22110
|
+
name: group_by
|
22111
|
+
required: false
|
22112
|
+
schema:
|
20157
22113
|
type: string
|
20158
|
-
- description:
|
22114
|
+
- description: Attribute to sort containers by.
|
22115
|
+
example: started_at
|
20159
22116
|
in: query
|
20160
22117
|
name: sort
|
20161
22118
|
required: false
|
20162
|
-
schema:
|
20163
|
-
$ref: '#/components/schemas/CIAppSort'
|
20164
|
-
- description: List following results with a cursor provided in the previous
|
20165
|
-
query.
|
20166
|
-
example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==
|
20167
|
-
in: query
|
20168
|
-
name: page[cursor]
|
20169
|
-
required: false
|
20170
22119
|
schema:
|
20171
22120
|
type: string
|
20172
|
-
- description: Maximum number of
|
20173
|
-
example: 25
|
22121
|
+
- description: Maximum number of results returned.
|
20174
22122
|
in: query
|
20175
|
-
name: page[
|
22123
|
+
name: page[size]
|
20176
22124
|
required: false
|
20177
22125
|
schema:
|
20178
|
-
default:
|
22126
|
+
default: 1000
|
20179
22127
|
format: int32
|
20180
|
-
maximum:
|
22128
|
+
maximum: 10000
|
22129
|
+
minimum: 1
|
20181
22130
|
type: integer
|
22131
|
+
- description: 'String to query the next page of results.
|
22132
|
+
|
22133
|
+
This key is provided with each valid response from the API in `meta.pagination.next_cursor`.'
|
22134
|
+
in: query
|
22135
|
+
name: page[cursor]
|
22136
|
+
required: false
|
22137
|
+
schema:
|
22138
|
+
type: string
|
20182
22139
|
responses:
|
20183
22140
|
'200':
|
20184
22141
|
content:
|
20185
22142
|
application/json:
|
20186
22143
|
schema:
|
20187
|
-
$ref: '#/components/schemas/
|
22144
|
+
$ref: '#/components/schemas/ContainersResponse'
|
20188
22145
|
description: OK
|
20189
22146
|
'400':
|
20190
|
-
|
22147
|
+
content:
|
22148
|
+
application/json:
|
22149
|
+
schema:
|
22150
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
22151
|
+
description: Bad Request
|
20191
22152
|
'403':
|
20192
|
-
|
22153
|
+
content:
|
22154
|
+
application/json:
|
22155
|
+
schema:
|
22156
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
22157
|
+
description: Authentication Error
|
20193
22158
|
'429':
|
20194
22159
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
20195
22160
|
security:
|
20196
22161
|
- apiKeyAuth: []
|
20197
22162
|
appKeyAuth: []
|
20198
|
-
- AuthZ:
|
20199
|
-
|
20200
|
-
summary: Get a list of pipelines events
|
22163
|
+
- AuthZ: []
|
22164
|
+
summary: Get All Containers
|
20201
22165
|
tags:
|
20202
|
-
-
|
22166
|
+
- Containers
|
20203
22167
|
x-pagination:
|
20204
22168
|
cursorParam: page[cursor]
|
20205
|
-
cursorPath: meta.
|
20206
|
-
limitParam: page[
|
22169
|
+
cursorPath: meta.pagination.next_cursor
|
22170
|
+
limitParam: page[size]
|
20207
22171
|
resultsPath: data
|
20208
|
-
/api/v2/
|
22172
|
+
/api/v2/cost/aws_cur_config:
|
22173
|
+
get:
|
22174
|
+
description: List the AWS CUR configs.
|
22175
|
+
operationId: ListCostAWSCURConfigs
|
22176
|
+
responses:
|
22177
|
+
'200':
|
22178
|
+
content:
|
22179
|
+
application/json:
|
22180
|
+
schema:
|
22181
|
+
$ref: '#/components/schemas/AwsCURConfigsResponse'
|
22182
|
+
description: OK
|
22183
|
+
'403':
|
22184
|
+
content:
|
22185
|
+
application/json:
|
22186
|
+
schema:
|
22187
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
22188
|
+
description: Forbidden
|
22189
|
+
'429':
|
22190
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
22191
|
+
summary: List Cloud Cost Management AWS CUR configs
|
22192
|
+
tags:
|
22193
|
+
- Cloud Cost Management
|
22194
|
+
x-permission:
|
22195
|
+
operator: OR
|
22196
|
+
permissions:
|
22197
|
+
- CLOUD_COST_MANAGEMENT_READ
|
20209
22198
|
post:
|
20210
|
-
description:
|
20211
|
-
|
20212
|
-
|
20213
|
-
[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).
|
20214
|
-
|
20215
|
-
|
20216
|
-
Use this endpoint to build complex events filtering and search.'
|
20217
|
-
operationId: SearchCIAppPipelineEvents
|
22199
|
+
description: Create a Cloud Cost Management account for an AWS CUR config.
|
22200
|
+
operationId: CreateCostAWSCURConfig
|
20218
22201
|
requestBody:
|
20219
22202
|
content:
|
20220
22203
|
application/json:
|
20221
22204
|
schema:
|
20222
|
-
$ref: '#/components/schemas/
|
20223
|
-
required:
|
22205
|
+
$ref: '#/components/schemas/AwsCURConfigPostRequest'
|
22206
|
+
required: true
|
20224
22207
|
responses:
|
20225
22208
|
'200':
|
20226
22209
|
content:
|
20227
22210
|
application/json:
|
20228
22211
|
schema:
|
20229
|
-
$ref: '#/components/schemas/
|
22212
|
+
$ref: '#/components/schemas/AwsCURConfigResponse'
|
20230
22213
|
description: OK
|
20231
22214
|
'400':
|
20232
|
-
|
22215
|
+
content:
|
22216
|
+
application/json:
|
22217
|
+
schema:
|
22218
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
22219
|
+
description: Bad Request
|
20233
22220
|
'403':
|
20234
|
-
|
22221
|
+
content:
|
22222
|
+
application/json:
|
22223
|
+
schema:
|
22224
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
22225
|
+
description: Forbidden
|
20235
22226
|
'429':
|
20236
22227
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
20237
|
-
|
20238
|
-
- apiKeyAuth: []
|
20239
|
-
appKeyAuth: []
|
20240
|
-
- AuthZ:
|
20241
|
-
- ci_visibility_read
|
20242
|
-
summary: Search pipelines events
|
22228
|
+
summary: Create Cloud Cost Management AWS CUR config
|
20243
22229
|
tags:
|
20244
|
-
-
|
20245
|
-
x-
|
20246
|
-
|
20247
|
-
|
20248
|
-
|
20249
|
-
|
20250
|
-
|
20251
|
-
|
20252
|
-
|
20253
|
-
|
20254
|
-
|
20255
|
-
|
22230
|
+
- Cloud Cost Management
|
22231
|
+
x-permission:
|
22232
|
+
operator: OR
|
22233
|
+
permissions:
|
22234
|
+
- CLOUD_COST_MANAGEMENT_WRITE
|
22235
|
+
/api/v2/cost/aws_cur_config/{cloud_account_id}:
|
22236
|
+
delete:
|
22237
|
+
description: Archive a Cloud Cost Management Account.
|
22238
|
+
operationId: DeleteCostAWSCURConfig
|
22239
|
+
parameters:
|
22240
|
+
- $ref: '#/components/parameters/CloudAccountID'
|
22241
|
+
responses:
|
22242
|
+
'204':
|
22243
|
+
description: No Content
|
22244
|
+
'400':
|
22245
|
+
content:
|
22246
|
+
application/json:
|
22247
|
+
schema:
|
22248
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
22249
|
+
description: Bad Request
|
22250
|
+
'404':
|
22251
|
+
content:
|
22252
|
+
application/json:
|
22253
|
+
schema:
|
22254
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
22255
|
+
description: Not Found
|
22256
|
+
'429':
|
22257
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
22258
|
+
summary: Delete Cloud Cost Management AWS CUR config
|
22259
|
+
tags:
|
22260
|
+
- Cloud Cost Management
|
22261
|
+
x-permission:
|
22262
|
+
operator: OR
|
22263
|
+
permissions:
|
22264
|
+
- CLOUD_COST_MANAGEMENT_WRITE
|
22265
|
+
patch:
|
22266
|
+
description: Update the status of an AWS CUR config (active/archived).
|
22267
|
+
operationId: UpdateCostAWSCURConfig
|
22268
|
+
parameters:
|
22269
|
+
- $ref: '#/components/parameters/CloudAccountID'
|
20256
22270
|
requestBody:
|
20257
22271
|
content:
|
20258
22272
|
application/json:
|
20259
22273
|
schema:
|
20260
|
-
$ref: '#/components/schemas/
|
22274
|
+
$ref: '#/components/schemas/AwsCURConfigPatchRequest'
|
20261
22275
|
required: true
|
20262
22276
|
responses:
|
20263
22277
|
'200':
|
20264
22278
|
content:
|
20265
22279
|
application/json:
|
20266
22280
|
schema:
|
20267
|
-
$ref: '#/components/schemas/
|
22281
|
+
$ref: '#/components/schemas/AwsCURConfigsResponse'
|
20268
22282
|
description: OK
|
20269
|
-
'400':
|
20270
|
-
$ref: '#/components/responses/BadRequestResponse'
|
20271
22283
|
'403':
|
20272
|
-
|
22284
|
+
content:
|
22285
|
+
application/json:
|
22286
|
+
schema:
|
22287
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
22288
|
+
description: Forbidden
|
20273
22289
|
'429':
|
20274
22290
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
20275
|
-
|
20276
|
-
- apiKeyAuth: []
|
20277
|
-
appKeyAuth: []
|
20278
|
-
- AuthZ:
|
20279
|
-
- ci_visibility_read
|
20280
|
-
summary: Aggregate tests events
|
22291
|
+
summary: Update Cloud Cost Management AWS CUR config
|
20281
22292
|
tags:
|
20282
|
-
-
|
20283
|
-
x-
|
20284
|
-
|
22293
|
+
- Cloud Cost Management
|
22294
|
+
x-permission:
|
22295
|
+
operator: OR
|
22296
|
+
permissions:
|
22297
|
+
- CLOUD_COST_MANAGEMENT_WRITE
|
22298
|
+
/api/v2/cost/aws_related_accounts:
|
20285
22299
|
get:
|
20286
|
-
description:
|
20287
|
-
|
20288
|
-
|
20289
|
-
[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).
|
20290
|
-
|
20291
|
-
|
20292
|
-
Use this endpoint to see your latest test events.'
|
20293
|
-
operationId: ListCIAppTestEvents
|
22300
|
+
description: List the AWS accounts in an organization by calling 'organizations:ListAccounts'
|
22301
|
+
from the specified management account.
|
22302
|
+
operationId: ListAWSRelatedAccounts
|
20294
22303
|
parameters:
|
20295
|
-
- description:
|
20296
|
-
example: '
|
20297
|
-
in: query
|
20298
|
-
name: filter[query]
|
20299
|
-
required: false
|
20300
|
-
schema:
|
20301
|
-
type: string
|
20302
|
-
- description: Minimum timestamp for requested events.
|
20303
|
-
example: '2019-01-02T09:42:36.320Z'
|
20304
|
-
in: query
|
20305
|
-
name: filter[from]
|
20306
|
-
required: false
|
20307
|
-
schema:
|
20308
|
-
format: date-time
|
20309
|
-
type: string
|
20310
|
-
- description: Maximum timestamp for requested events.
|
20311
|
-
example: '2019-01-03T09:42:36.320Z'
|
22304
|
+
- description: The ID of the management account to filter by.
|
22305
|
+
example: '123456789123'
|
20312
22306
|
in: query
|
20313
|
-
name: filter[
|
20314
|
-
required:
|
20315
|
-
schema:
|
20316
|
-
format: date-time
|
20317
|
-
type: string
|
20318
|
-
- description: Order of events in results.
|
20319
|
-
in: query
|
20320
|
-
name: sort
|
20321
|
-
required: false
|
20322
|
-
schema:
|
20323
|
-
$ref: '#/components/schemas/CIAppSort'
|
20324
|
-
- description: List following results with a cursor provided in the previous
|
20325
|
-
query.
|
20326
|
-
example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==
|
20327
|
-
in: query
|
20328
|
-
name: page[cursor]
|
20329
|
-
required: false
|
22307
|
+
name: filter[management_account_id]
|
22308
|
+
required: true
|
20330
22309
|
schema:
|
20331
22310
|
type: string
|
20332
|
-
- description: Maximum number of events in the response.
|
20333
|
-
example: 25
|
20334
|
-
in: query
|
20335
|
-
name: page[limit]
|
20336
|
-
required: false
|
20337
|
-
schema:
|
20338
|
-
default: 10
|
20339
|
-
format: int32
|
20340
|
-
maximum: 1000
|
20341
|
-
type: integer
|
20342
22311
|
responses:
|
20343
22312
|
'200':
|
20344
22313
|
content:
|
20345
22314
|
application/json:
|
20346
22315
|
schema:
|
20347
|
-
$ref: '#/components/schemas/
|
22316
|
+
$ref: '#/components/schemas/AWSRelatedAccountsResponse'
|
22317
|
+
description: OK
|
22318
|
+
'400':
|
22319
|
+
content:
|
22320
|
+
application/json:
|
22321
|
+
schema:
|
22322
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
22323
|
+
description: Bad Request
|
22324
|
+
'403':
|
22325
|
+
content:
|
22326
|
+
application/json:
|
22327
|
+
schema:
|
22328
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
22329
|
+
description: Forbidden
|
22330
|
+
'429':
|
22331
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
22332
|
+
summary: List related AWS accounts
|
22333
|
+
tags:
|
22334
|
+
- Cloud Cost Management
|
22335
|
+
x-permission:
|
22336
|
+
operator: OR
|
22337
|
+
permissions:
|
22338
|
+
- CLOUD_COST_MANAGEMENT_READ
|
22339
|
+
/api/v2/cost/azure_uc_config:
|
22340
|
+
get:
|
22341
|
+
description: List the Azure configs.
|
22342
|
+
operationId: ListCostAzureUCConfigs
|
22343
|
+
responses:
|
22344
|
+
'200':
|
22345
|
+
content:
|
22346
|
+
application/json:
|
22347
|
+
schema:
|
22348
|
+
$ref: '#/components/schemas/AzureUCConfigsResponse'
|
22349
|
+
description: OK
|
22350
|
+
'403':
|
22351
|
+
content:
|
22352
|
+
application/json:
|
22353
|
+
schema:
|
22354
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
22355
|
+
description: Forbidden
|
22356
|
+
'429':
|
22357
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
22358
|
+
summary: List Cloud Cost Management Azure configs
|
22359
|
+
tags:
|
22360
|
+
- Cloud Cost Management
|
22361
|
+
x-permission:
|
22362
|
+
operator: OR
|
22363
|
+
permissions:
|
22364
|
+
- CLOUD_COST_MANAGEMENT_READ
|
22365
|
+
post:
|
22366
|
+
description: Create a Cloud Cost Management account for an Azure config.
|
22367
|
+
operationId: CreateCostAzureUCConfigs
|
22368
|
+
requestBody:
|
22369
|
+
content:
|
22370
|
+
application/json:
|
22371
|
+
schema:
|
22372
|
+
$ref: '#/components/schemas/AzureUCConfigPostRequest'
|
22373
|
+
required: true
|
22374
|
+
responses:
|
22375
|
+
'200':
|
22376
|
+
content:
|
22377
|
+
application/json:
|
22378
|
+
schema:
|
22379
|
+
$ref: '#/components/schemas/AzureUCConfigPairsResponse'
|
20348
22380
|
description: OK
|
20349
22381
|
'400':
|
20350
|
-
|
22382
|
+
content:
|
22383
|
+
application/json:
|
22384
|
+
schema:
|
22385
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
22386
|
+
description: Bad Request
|
20351
22387
|
'403':
|
20352
|
-
|
22388
|
+
content:
|
22389
|
+
application/json:
|
22390
|
+
schema:
|
22391
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
22392
|
+
description: Forbidden
|
20353
22393
|
'429':
|
20354
22394
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
20355
|
-
|
20356
|
-
- apiKeyAuth: []
|
20357
|
-
appKeyAuth: []
|
20358
|
-
- AuthZ:
|
20359
|
-
- ci_visibility_read
|
20360
|
-
summary: Get a list of tests events
|
22395
|
+
summary: Create Cloud Cost Management Azure configs
|
20361
22396
|
tags:
|
20362
|
-
-
|
20363
|
-
x-
|
20364
|
-
|
20365
|
-
|
20366
|
-
|
20367
|
-
|
20368
|
-
|
20369
|
-
|
20370
|
-
|
20371
|
-
|
20372
|
-
|
20373
|
-
|
20374
|
-
|
20375
|
-
|
20376
|
-
|
20377
|
-
|
22397
|
+
- Cloud Cost Management
|
22398
|
+
x-permission:
|
22399
|
+
operator: OR
|
22400
|
+
permissions:
|
22401
|
+
- CLOUD_COST_MANAGEMENT_WRITE
|
22402
|
+
/api/v2/cost/azure_uc_config/{cloud_account_id}:
|
22403
|
+
delete:
|
22404
|
+
description: Archive a Cloud Cost Management Account.
|
22405
|
+
operationId: DeleteCostAzureUCConfig
|
22406
|
+
parameters:
|
22407
|
+
- $ref: '#/components/parameters/CloudAccountID'
|
22408
|
+
responses:
|
22409
|
+
'204':
|
22410
|
+
description: No Content
|
22411
|
+
'400':
|
22412
|
+
content:
|
22413
|
+
application/json:
|
22414
|
+
schema:
|
22415
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
22416
|
+
description: Bad Request
|
22417
|
+
'404':
|
22418
|
+
content:
|
22419
|
+
application/json:
|
22420
|
+
schema:
|
22421
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
22422
|
+
description: Not Found
|
22423
|
+
'429':
|
22424
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
22425
|
+
summary: Delete Cloud Cost Management Azure config
|
22426
|
+
tags:
|
22427
|
+
- Cloud Cost Management
|
22428
|
+
x-permission:
|
22429
|
+
operator: OR
|
22430
|
+
permissions:
|
22431
|
+
- CLOUD_COST_MANAGEMENT_WRITE
|
22432
|
+
patch:
|
22433
|
+
description: Update the status of an Azure config (active/archived).
|
22434
|
+
operationId: UpdateCostAzureUCConfigs
|
22435
|
+
parameters:
|
22436
|
+
- $ref: '#/components/parameters/CloudAccountID'
|
20378
22437
|
requestBody:
|
20379
22438
|
content:
|
20380
22439
|
application/json:
|
20381
22440
|
schema:
|
20382
|
-
$ref: '#/components/schemas/
|
20383
|
-
required:
|
22441
|
+
$ref: '#/components/schemas/AzureUCConfigPatchRequest'
|
22442
|
+
required: true
|
20384
22443
|
responses:
|
20385
22444
|
'200':
|
20386
22445
|
content:
|
20387
22446
|
application/json:
|
20388
22447
|
schema:
|
20389
|
-
$ref: '#/components/schemas/
|
22448
|
+
$ref: '#/components/schemas/AzureUCConfigPairsResponse'
|
20390
22449
|
description: OK
|
20391
22450
|
'400':
|
20392
|
-
|
22451
|
+
content:
|
22452
|
+
application/json:
|
22453
|
+
schema:
|
22454
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
22455
|
+
description: Bad Request
|
20393
22456
|
'403':
|
20394
|
-
|
22457
|
+
content:
|
22458
|
+
application/json:
|
22459
|
+
schema:
|
22460
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
22461
|
+
description: Forbidden
|
20395
22462
|
'429':
|
20396
22463
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
20397
|
-
|
20398
|
-
- apiKeyAuth: []
|
20399
|
-
appKeyAuth: []
|
20400
|
-
- AuthZ:
|
20401
|
-
- ci_visibility_read
|
20402
|
-
summary: Search tests events
|
22464
|
+
summary: Update Cloud Cost Management Azure config
|
20403
22465
|
tags:
|
20404
|
-
-
|
20405
|
-
x-
|
20406
|
-
|
20407
|
-
|
20408
|
-
|
20409
|
-
|
20410
|
-
resultsPath: data
|
20411
|
-
/api/v2/container_images:
|
22466
|
+
- Cloud Cost Management
|
22467
|
+
x-permission:
|
22468
|
+
operator: OR
|
22469
|
+
permissions:
|
22470
|
+
- CLOUD_COST_MANAGEMENT_WRITE
|
22471
|
+
/api/v2/cost/enabled:
|
20412
22472
|
get:
|
20413
|
-
description: Get
|
20414
|
-
operationId:
|
20415
|
-
parameters:
|
20416
|
-
- description: Comma-separated list of tags to filter Container Images by.
|
20417
|
-
example: short_image:redis,status:running
|
20418
|
-
in: query
|
20419
|
-
name: filter[tags]
|
20420
|
-
required: false
|
20421
|
-
schema:
|
20422
|
-
type: string
|
20423
|
-
- description: Comma-separated list of tags to group Container Images by.
|
20424
|
-
example: registry,image_tags
|
20425
|
-
in: query
|
20426
|
-
name: group_by
|
20427
|
-
required: false
|
20428
|
-
schema:
|
20429
|
-
type: string
|
20430
|
-
- description: Attribute to sort Container Images by.
|
20431
|
-
example: container_count
|
20432
|
-
in: query
|
20433
|
-
name: sort
|
20434
|
-
required: false
|
20435
|
-
schema:
|
20436
|
-
type: string
|
20437
|
-
- description: Maximum number of results returned.
|
20438
|
-
in: query
|
20439
|
-
name: page[size]
|
20440
|
-
required: false
|
20441
|
-
schema:
|
20442
|
-
default: 1000
|
20443
|
-
format: int32
|
20444
|
-
maximum: 10000
|
20445
|
-
minimum: 1
|
20446
|
-
type: integer
|
20447
|
-
- description: 'String to query the next page of results.
|
20448
|
-
|
20449
|
-
This key is provided with each valid response from the API in `meta.pagination.next_cursor`.'
|
20450
|
-
in: query
|
20451
|
-
name: page[cursor]
|
20452
|
-
required: false
|
20453
|
-
schema:
|
20454
|
-
type: string
|
22473
|
+
description: Get the Cloud Cost Management activity.
|
22474
|
+
operationId: GetCloudCostActivity
|
20455
22475
|
responses:
|
20456
22476
|
'200':
|
20457
22477
|
content:
|
20458
22478
|
application/json:
|
20459
22479
|
schema:
|
20460
|
-
$ref: '#/components/schemas/
|
22480
|
+
$ref: '#/components/schemas/CloudCostActivityResponse'
|
20461
22481
|
description: OK
|
20462
|
-
'
|
22482
|
+
'403':
|
20463
22483
|
content:
|
20464
22484
|
application/json:
|
20465
22485
|
schema:
|
20466
22486
|
$ref: '#/components/schemas/APIErrorResponse'
|
22487
|
+
description: Forbidden
|
22488
|
+
'429':
|
22489
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
22490
|
+
summary: Cloud Cost Enabled
|
22491
|
+
tags:
|
22492
|
+
- Cloud Cost Management
|
22493
|
+
x-permission:
|
22494
|
+
operator: OR
|
22495
|
+
permissions:
|
22496
|
+
- CLOUD_COST_MANAGEMENT_READ
|
22497
|
+
/api/v2/cost_by_tag/active_billing_dimensions:
|
22498
|
+
get:
|
22499
|
+
description: Get active billing dimensions for cost attribution. Cost data for
|
22500
|
+
a given month becomes available no later than the 17th of the following month.
|
22501
|
+
operationId: GetActiveBillingDimensions
|
22502
|
+
responses:
|
22503
|
+
'200':
|
22504
|
+
content:
|
22505
|
+
application/json;datetime-format=rfc3339:
|
22506
|
+
schema:
|
22507
|
+
$ref: '#/components/schemas/ActiveBillingDimensionsResponse'
|
22508
|
+
description: OK
|
22509
|
+
'400':
|
22510
|
+
content:
|
22511
|
+
application/json;datetime-format=rfc3339:
|
22512
|
+
schema:
|
22513
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
20467
22514
|
description: Bad Request
|
20468
22515
|
'403':
|
20469
22516
|
content:
|
20470
|
-
application/json:
|
22517
|
+
application/json;datetime-format=rfc3339:
|
20471
22518
|
schema:
|
20472
22519
|
$ref: '#/components/schemas/APIErrorResponse'
|
20473
|
-
description:
|
22520
|
+
description: Forbidden - User is not authorized
|
20474
22521
|
'429':
|
20475
|
-
|
22522
|
+
content:
|
22523
|
+
application/json;datetime-format=rfc3339:
|
22524
|
+
schema:
|
22525
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
22526
|
+
description: Too many requests
|
20476
22527
|
security:
|
20477
22528
|
- apiKeyAuth: []
|
20478
22529
|
appKeyAuth: []
|
20479
22530
|
- AuthZ: []
|
20480
|
-
summary: Get
|
22531
|
+
summary: Get active billing dimensions for cost attribution
|
20481
22532
|
tags:
|
20482
|
-
-
|
20483
|
-
x-pagination:
|
20484
|
-
cursorParam: page[cursor]
|
20485
|
-
cursorPath: meta.pagination.next_cursor
|
20486
|
-
limitParam: page[size]
|
20487
|
-
resultsPath: data
|
22533
|
+
- Usage Metering
|
20488
22534
|
x-unstable: '**Note**: This endpoint is in public beta.
|
20489
22535
|
|
20490
22536
|
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
20491
|
-
/api/v2/
|
22537
|
+
/api/v2/cost_by_tag/monthly_cost_attribution:
|
20492
22538
|
get:
|
20493
|
-
description: Get
|
20494
|
-
|
22539
|
+
description: "Get monthly cost attribution by tag across multi-org and single
|
22540
|
+
root-org accounts.\nCost Attribution data for a given month becomes available
|
22541
|
+
no later than the 17th of the following month.\nThis API endpoint is paginated.
|
22542
|
+
To make sure you receive all records, check if the value of `next_record_id`
|
22543
|
+
is\nset in the response. If it is, make another request and pass `next_record_id`
|
22544
|
+
as a parameter.\nPseudo code example:\n```\nresponse := GetMonthlyCostAttribution(start_month,
|
22545
|
+
end_month)\ncursor := response.metadata.pagination.next_record_id\nWHILE cursor
|
22546
|
+
!= null BEGIN\n sleep(5 seconds) # Avoid running into rate limit\n response
|
22547
|
+
:= GetMonthlyCostAttribution(start_month, end_month, next_record_id=cursor)\n
|
22548
|
+
\ cursor := response.metadata.pagination.next_record_id\nEND\n```"
|
22549
|
+
operationId: GetMonthlyCostAttribution
|
20495
22550
|
parameters:
|
20496
|
-
- description:
|
20497
|
-
|
22551
|
+
- description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]`
|
22552
|
+
for cost beginning in this month.'
|
20498
22553
|
in: query
|
20499
|
-
name:
|
20500
|
-
required:
|
22554
|
+
name: start_month
|
22555
|
+
required: true
|
20501
22556
|
schema:
|
22557
|
+
format: date-time
|
20502
22558
|
type: string
|
20503
|
-
- description:
|
20504
|
-
|
22559
|
+
- description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]`
|
22560
|
+
for cost ending this month.'
|
20505
22561
|
in: query
|
20506
|
-
name:
|
20507
|
-
required:
|
22562
|
+
name: end_month
|
22563
|
+
required: true
|
20508
22564
|
schema:
|
22565
|
+
format: date-time
|
20509
22566
|
type: string
|
20510
|
-
- description:
|
20511
|
-
|
22567
|
+
- description: 'Comma-separated list specifying cost types (e.g., `<billing_dimension>_on_demand_cost`,
|
22568
|
+
`<billing_dimension>_committed_cost`, `<billing_dimension>_total_cost`)
|
22569
|
+
and the
|
22570
|
+
|
22571
|
+
proportions (`<billing_dimension>_percentage_in_org`, `<billing_dimension>_percentage_in_account`).
|
22572
|
+
Use `*` to retrieve all fields.
|
22573
|
+
|
22574
|
+
Example: `infra_host_on_demand_cost,infra_host_percentage_in_account`
|
22575
|
+
|
22576
|
+
To obtain the complete list of active billing dimensions that can be used
|
22577
|
+
to replace
|
22578
|
+
|
22579
|
+
`<billing_dimension>` in the field names, make a request to the [Get active
|
22580
|
+
billing dimensions API](https://docs.datadoghq.com/api/latest/usage-metering/#get-active-billing-dimensions-for-cost-attribution).'
|
20512
22581
|
in: query
|
20513
|
-
name:
|
20514
|
-
required:
|
22582
|
+
name: fields
|
22583
|
+
required: true
|
20515
22584
|
schema:
|
20516
22585
|
type: string
|
20517
|
-
- description:
|
22586
|
+
- description: 'The direction to sort by: `[desc, asc]`.'
|
20518
22587
|
in: query
|
20519
|
-
name:
|
22588
|
+
name: sort_direction
|
20520
22589
|
required: false
|
20521
22590
|
schema:
|
20522
|
-
|
20523
|
-
|
20524
|
-
|
20525
|
-
|
20526
|
-
|
20527
|
-
|
22591
|
+
$ref: '#/components/schemas/SortDirection'
|
22592
|
+
- description: 'The billing dimension to sort by. Always sorted by total cost.
|
22593
|
+
Example: `infra_host`.'
|
22594
|
+
in: query
|
22595
|
+
name: sort_name
|
22596
|
+
required: false
|
22597
|
+
schema:
|
22598
|
+
type: string
|
22599
|
+
- description: 'Comma separated list of tag keys used to group cost. If no value
|
22600
|
+
is provided the cost will not be broken down by tags.
|
20528
22601
|
|
20529
|
-
|
22602
|
+
To see which tags are available, look for the value of `tag_config_source`
|
22603
|
+
in the API response.'
|
20530
22604
|
in: query
|
20531
|
-
name:
|
22605
|
+
name: tag_breakdown_keys
|
22606
|
+
required: false
|
22607
|
+
schema:
|
22608
|
+
type: string
|
22609
|
+
- description: List following results with a next_record_id provided in the
|
22610
|
+
previous query.
|
22611
|
+
in: query
|
22612
|
+
name: next_record_id
|
20532
22613
|
required: false
|
20533
22614
|
schema:
|
20534
22615
|
type: string
|
22616
|
+
- description: Include child org cost in the response. Defaults to `true`.
|
22617
|
+
in: query
|
22618
|
+
name: include_descendants
|
22619
|
+
required: false
|
22620
|
+
schema:
|
22621
|
+
default: true
|
22622
|
+
type: boolean
|
20535
22623
|
responses:
|
20536
22624
|
'200':
|
20537
22625
|
content:
|
20538
|
-
application/json:
|
22626
|
+
application/json;datetime-format=rfc3339:
|
20539
22627
|
schema:
|
20540
|
-
$ref: '#/components/schemas/
|
22628
|
+
$ref: '#/components/schemas/MonthlyCostAttributionResponse'
|
20541
22629
|
description: OK
|
20542
22630
|
'400':
|
20543
22631
|
content:
|
20544
|
-
application/json:
|
22632
|
+
application/json;datetime-format=rfc3339:
|
20545
22633
|
schema:
|
20546
22634
|
$ref: '#/components/schemas/APIErrorResponse'
|
20547
22635
|
description: Bad Request
|
20548
22636
|
'403':
|
20549
22637
|
content:
|
20550
|
-
application/json:
|
22638
|
+
application/json;datetime-format=rfc3339:
|
20551
22639
|
schema:
|
20552
22640
|
$ref: '#/components/schemas/APIErrorResponse'
|
20553
|
-
description:
|
22641
|
+
description: Forbidden - User is not authorized
|
20554
22642
|
'429':
|
20555
|
-
|
22643
|
+
content:
|
22644
|
+
application/json;datetime-format=rfc3339:
|
22645
|
+
schema:
|
22646
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
22647
|
+
description: Too many requests
|
20556
22648
|
security:
|
20557
22649
|
- apiKeyAuth: []
|
20558
22650
|
appKeyAuth: []
|
20559
22651
|
- AuthZ: []
|
20560
|
-
summary: Get
|
22652
|
+
summary: Get Monthly Cost Attribution
|
20561
22653
|
tags:
|
20562
|
-
-
|
20563
|
-
x-pagination:
|
20564
|
-
cursorParam: page[cursor]
|
20565
|
-
cursorPath: meta.pagination.next_cursor
|
20566
|
-
limitParam: page[size]
|
20567
|
-
resultsPath: data
|
22654
|
+
- Usage Metering
|
20568
22655
|
x-unstable: '**Note**: This endpoint is in public beta.
|
20569
22656
|
|
20570
22657
|
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
@@ -20929,6 +23016,108 @@ paths:
|
|
20929
23016
|
tags:
|
20930
23017
|
- Dashboard Lists
|
20931
23018
|
x-codegen-request-body-name: body
|
23019
|
+
/api/v2/dora/deployment:
|
23020
|
+
post:
|
23021
|
+
description: 'Use this API endpoint to provide data about deployments for DORA
|
23022
|
+
metrics.
|
23023
|
+
|
23024
|
+
|
23025
|
+
This is necessary for:
|
23026
|
+
|
23027
|
+
- Deployment Frequency
|
23028
|
+
|
23029
|
+
- Change Lead Time
|
23030
|
+
|
23031
|
+
- Change Failure Rate'
|
23032
|
+
operationId: CreateDORADeployment
|
23033
|
+
requestBody:
|
23034
|
+
content:
|
23035
|
+
application/json:
|
23036
|
+
schema:
|
23037
|
+
$ref: '#/components/schemas/DORADeploymentRequest'
|
23038
|
+
required: true
|
23039
|
+
responses:
|
23040
|
+
'200':
|
23041
|
+
content:
|
23042
|
+
application/json:
|
23043
|
+
schema:
|
23044
|
+
$ref: '#/components/schemas/DORADeploymentResponse'
|
23045
|
+
description: OK
|
23046
|
+
'202':
|
23047
|
+
content:
|
23048
|
+
application/json:
|
23049
|
+
schema:
|
23050
|
+
$ref: '#/components/schemas/DORADeploymentResponse'
|
23051
|
+
description: OK - but delayed due to incident
|
23052
|
+
'400':
|
23053
|
+
content:
|
23054
|
+
application/json:
|
23055
|
+
schema:
|
23056
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
23057
|
+
description: Bad Request
|
23058
|
+
'403':
|
23059
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
23060
|
+
'429':
|
23061
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
23062
|
+
security:
|
23063
|
+
- apiKeyAuth: []
|
23064
|
+
summary: Send a deployment event for DORA Metrics
|
23065
|
+
tags:
|
23066
|
+
- DORA Metrics
|
23067
|
+
x-codegen-request-body-name: body
|
23068
|
+
x-unstable: '**Note**: This endpoint is in private beta.
|
23069
|
+
|
23070
|
+
If you want to request access, complete the [form](https://forms.gle/Eqq6uXfGjYxmqpjDA).'
|
23071
|
+
/api/v2/dora/incident:
|
23072
|
+
post:
|
23073
|
+
description: 'Use this API endpoint to provide data about incidents for DORA
|
23074
|
+
metrics.
|
23075
|
+
|
23076
|
+
|
23077
|
+
This is necessary for:
|
23078
|
+
|
23079
|
+
- Change Failure Rate
|
23080
|
+
|
23081
|
+
- Time to Restore'
|
23082
|
+
operationId: CreateDORAIncident
|
23083
|
+
requestBody:
|
23084
|
+
content:
|
23085
|
+
application/json:
|
23086
|
+
schema:
|
23087
|
+
$ref: '#/components/schemas/DORAIncidentRequest'
|
23088
|
+
required: true
|
23089
|
+
responses:
|
23090
|
+
'200':
|
23091
|
+
content:
|
23092
|
+
application/json:
|
23093
|
+
schema:
|
23094
|
+
$ref: '#/components/schemas/DORAIncidentResponse'
|
23095
|
+
description: OK
|
23096
|
+
'202':
|
23097
|
+
content:
|
23098
|
+
application/json:
|
23099
|
+
schema:
|
23100
|
+
$ref: '#/components/schemas/DORAIncidentResponse'
|
23101
|
+
description: OK - but delayed due to incident
|
23102
|
+
'400':
|
23103
|
+
content:
|
23104
|
+
application/json:
|
23105
|
+
schema:
|
23106
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
23107
|
+
description: Bad Request
|
23108
|
+
'403':
|
23109
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
23110
|
+
'429':
|
23111
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
23112
|
+
security:
|
23113
|
+
- apiKeyAuth: []
|
23114
|
+
summary: Send an incident event for DORA Metrics
|
23115
|
+
tags:
|
23116
|
+
- DORA Metrics
|
23117
|
+
x-codegen-request-body-name: body
|
23118
|
+
x-unstable: '**Note**: This endpoint is in private beta.
|
23119
|
+
|
23120
|
+
If you want to request access, complete the [form](https://forms.gle/Eqq6uXfGjYxmqpjDA).'
|
20932
23121
|
/api/v2/downtime:
|
20933
23122
|
get:
|
20934
23123
|
description: Get all scheduled downtimes.
|
@@ -21252,9 +23441,6 @@ paths:
|
|
21252
23441
|
cursorPath: meta.page.after
|
21253
23442
|
limitParam: page[limit]
|
21254
23443
|
resultsPath: data
|
21255
|
-
x-unstable: '**Note**: This endpoint is in beta.
|
21256
|
-
|
21257
|
-
For access, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
21258
23444
|
/api/v2/events/search:
|
21259
23445
|
post:
|
21260
23446
|
description: 'List endpoint returns events that match an events search query.
|
@@ -21297,9 +23483,6 @@ paths:
|
|
21297
23483
|
cursorPath: meta.page.after
|
21298
23484
|
limitParam: body.page.limit
|
21299
23485
|
resultsPath: data
|
21300
|
-
x-unstable: '**Note**: This endpoint is in beta.
|
21301
|
-
|
21302
|
-
For access, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
21303
23486
|
/api/v2/incidents:
|
21304
23487
|
get:
|
21305
23488
|
description: Get all incidents for the user's organization.
|
@@ -22897,6 +25080,144 @@ paths:
|
|
22897
25080
|
tags:
|
22898
25081
|
- Fastly Integration
|
22899
25082
|
x-codegen-request-body-name: body
|
25083
|
+
/api/v2/integrations/okta/accounts:
|
25084
|
+
get:
|
25085
|
+
description: List Okta accounts.
|
25086
|
+
operationId: ListOktaAccounts
|
25087
|
+
responses:
|
25088
|
+
'200':
|
25089
|
+
content:
|
25090
|
+
application/json:
|
25091
|
+
schema:
|
25092
|
+
$ref: '#/components/schemas/OktaAccountsResponse'
|
25093
|
+
description: OK
|
25094
|
+
'400':
|
25095
|
+
$ref: '#/components/responses/BadRequestResponse'
|
25096
|
+
'403':
|
25097
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
25098
|
+
'404':
|
25099
|
+
$ref: '#/components/responses/NotFoundResponse'
|
25100
|
+
'429':
|
25101
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
25102
|
+
summary: List Okta accounts
|
25103
|
+
tags:
|
25104
|
+
- Okta Integration
|
25105
|
+
post:
|
25106
|
+
description: Create an Okta account.
|
25107
|
+
operationId: CreateOktaAccount
|
25108
|
+
requestBody:
|
25109
|
+
content:
|
25110
|
+
application/json:
|
25111
|
+
schema:
|
25112
|
+
$ref: '#/components/schemas/OktaAccountRequest'
|
25113
|
+
required: true
|
25114
|
+
responses:
|
25115
|
+
'201':
|
25116
|
+
content:
|
25117
|
+
application/json:
|
25118
|
+
schema:
|
25119
|
+
$ref: '#/components/schemas/OktaAccountResponse'
|
25120
|
+
description: OK
|
25121
|
+
'400':
|
25122
|
+
$ref: '#/components/responses/BadRequestResponse'
|
25123
|
+
'403':
|
25124
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
25125
|
+
'404':
|
25126
|
+
$ref: '#/components/responses/NotFoundResponse'
|
25127
|
+
'429':
|
25128
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
25129
|
+
summary: Add Okta account
|
25130
|
+
tags:
|
25131
|
+
- Okta Integration
|
25132
|
+
x-codegen-request-body-name: body
|
25133
|
+
/api/v2/integrations/okta/accounts/{account_id}:
|
25134
|
+
delete:
|
25135
|
+
description: Delete an Okta account.
|
25136
|
+
operationId: DeleteOktaAccount
|
25137
|
+
parameters:
|
25138
|
+
- description: None
|
25139
|
+
in: path
|
25140
|
+
name: account_id
|
25141
|
+
required: true
|
25142
|
+
schema:
|
25143
|
+
type: string
|
25144
|
+
responses:
|
25145
|
+
'204':
|
25146
|
+
description: OK
|
25147
|
+
'400':
|
25148
|
+
$ref: '#/components/responses/BadRequestResponse'
|
25149
|
+
'403':
|
25150
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
25151
|
+
'404':
|
25152
|
+
$ref: '#/components/responses/NotFoundResponse'
|
25153
|
+
'429':
|
25154
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
25155
|
+
summary: Delete Okta account
|
25156
|
+
tags:
|
25157
|
+
- Okta Integration
|
25158
|
+
get:
|
25159
|
+
description: Get an Okta account.
|
25160
|
+
operationId: GetOktaAccount
|
25161
|
+
parameters:
|
25162
|
+
- description: None
|
25163
|
+
in: path
|
25164
|
+
name: account_id
|
25165
|
+
required: true
|
25166
|
+
schema:
|
25167
|
+
type: string
|
25168
|
+
responses:
|
25169
|
+
'200':
|
25170
|
+
content:
|
25171
|
+
application/json:
|
25172
|
+
schema:
|
25173
|
+
$ref: '#/components/schemas/OktaAccountResponse'
|
25174
|
+
description: OK
|
25175
|
+
'400':
|
25176
|
+
$ref: '#/components/responses/BadRequestResponse'
|
25177
|
+
'403':
|
25178
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
25179
|
+
'404':
|
25180
|
+
$ref: '#/components/responses/NotFoundResponse'
|
25181
|
+
'429':
|
25182
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
25183
|
+
summary: Get Okta account
|
25184
|
+
tags:
|
25185
|
+
- Okta Integration
|
25186
|
+
patch:
|
25187
|
+
description: Update an Okta account.
|
25188
|
+
operationId: UpdateOktaAccount
|
25189
|
+
parameters:
|
25190
|
+
- description: None
|
25191
|
+
in: path
|
25192
|
+
name: account_id
|
25193
|
+
required: true
|
25194
|
+
schema:
|
25195
|
+
type: string
|
25196
|
+
requestBody:
|
25197
|
+
content:
|
25198
|
+
application/json:
|
25199
|
+
schema:
|
25200
|
+
$ref: '#/components/schemas/OktaAccountUpdateRequest'
|
25201
|
+
required: true
|
25202
|
+
responses:
|
25203
|
+
'200':
|
25204
|
+
content:
|
25205
|
+
application/json:
|
25206
|
+
schema:
|
25207
|
+
$ref: '#/components/schemas/OktaAccountResponse'
|
25208
|
+
description: OK
|
25209
|
+
'400':
|
25210
|
+
$ref: '#/components/responses/BadRequestResponse'
|
25211
|
+
'403':
|
25212
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
25213
|
+
'404':
|
25214
|
+
$ref: '#/components/responses/NotFoundResponse'
|
25215
|
+
'429':
|
25216
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
25217
|
+
summary: Update Okta account
|
25218
|
+
tags:
|
25219
|
+
- Okta Integration
|
25220
|
+
x-codegen-request-body-name: body
|
22900
25221
|
/api/v2/ip_allowlist:
|
22901
25222
|
get:
|
22902
25223
|
description: Returns the IP allowlist and its enabled or disabled state.
|
@@ -23904,8 +26225,8 @@ paths:
|
|
23904
26225
|
required: false
|
23905
26226
|
schema:
|
23906
26227
|
type: boolean
|
23907
|
-
- description: 'Filter custom metrics that have or have not been queried
|
23908
|
-
the specified window[seconds].
|
26228
|
+
- description: '(Beta) Filter custom metrics that have or have not been queried
|
26229
|
+
in the specified window[seconds].
|
23909
26230
|
|
23910
26231
|
If no window is provided or the window is less than 2 hours, a default of
|
23911
26232
|
2 hours will be applied.'
|
@@ -24373,7 +26694,9 @@ paths:
|
|
24373
26694
|
queryable.
|
24374
26695
|
|
24375
26696
|
Can only be used with application keys from users with the `Manage Tags for
|
24376
|
-
Metrics` permission.
|
26697
|
+
Metrics` permission. This endpoint requires
|
26698
|
+
|
26699
|
+
a tag configuration to be created first.'
|
24377
26700
|
operationId: UpdateTagConfiguration
|
24378
26701
|
parameters:
|
24379
26702
|
- $ref: '#/components/parameters/MetricName'
|
@@ -24726,6 +27049,16 @@ paths:
|
|
24726
27049
|
schema:
|
24727
27050
|
format: int64
|
24728
27051
|
type: integer
|
27052
|
+
- $ref: '#/components/parameters/PageOffset'
|
27053
|
+
- description: Maximum number of downtimes in the response.
|
27054
|
+
example: 100
|
27055
|
+
in: query
|
27056
|
+
name: page[limit]
|
27057
|
+
required: false
|
27058
|
+
schema:
|
27059
|
+
default: 30
|
27060
|
+
format: int64
|
27061
|
+
type: integer
|
24729
27062
|
responses:
|
24730
27063
|
'200':
|
24731
27064
|
content:
|
@@ -24750,6 +27083,10 @@ paths:
|
|
24750
27083
|
tags:
|
24751
27084
|
- Downtimes
|
24752
27085
|
x-codegen-request-body-name: body
|
27086
|
+
x-pagination:
|
27087
|
+
limitParam: page[limit]
|
27088
|
+
pageOffsetParam: page[offset]
|
27089
|
+
resultsPath: data
|
24753
27090
|
/api/v2/permissions:
|
24754
27091
|
get:
|
24755
27092
|
description: Returns a list of all permissions, including name, description,
|
@@ -25339,10 +27676,9 @@ paths:
|
|
25339
27676
|
- Metrics
|
25340
27677
|
x-codegen-request-body-name: body
|
25341
27678
|
x-unstable: '**Note**: This endpoint is GA for Metrics, Real User Monitoring
|
25342
|
-
(RUM),
|
27679
|
+
(RUM), Cloud Cost Management, and Log Management data sources.
|
25343
27680
|
|
25344
|
-
|
25345
|
-
sources. If you have any
|
27681
|
+
We are gradually onboarding support for more sources. If you have any
|
25346
27682
|
|
25347
27683
|
feedback, contact [Datadog Support](https://docs.datadoghq.com/help/).'
|
25348
27684
|
/api/v2/query/timeseries:
|
@@ -25382,10 +27718,9 @@ paths:
|
|
25382
27718
|
- Metrics
|
25383
27719
|
x-codegen-request-body-name: body
|
25384
27720
|
x-unstable: '**Note**: This endpoint is GA for Metrics, Real User Monitoring
|
25385
|
-
(RUM),
|
27721
|
+
(RUM), Cloud Cost Management, and Log Management data sources.
|
25386
27722
|
|
25387
|
-
|
25388
|
-
sources. If you have any
|
27723
|
+
We are gradually onboarding support for more sources. If you have any
|
25389
27724
|
|
25390
27725
|
feedback, contact [Datadog Support](https://docs.datadoghq.com/help/).'
|
25391
27726
|
/api/v2/restriction_policy/{resource_id}:
|
@@ -29935,6 +32270,57 @@ paths:
|
|
29935
32270
|
summary: Get hourly usage for observability pipelines
|
29936
32271
|
tags:
|
29937
32272
|
- Usage Metering
|
32273
|
+
/api/v2/usage/projected_cost:
|
32274
|
+
get:
|
32275
|
+
description: 'Get projected cost across multi-org and single root-org accounts.
|
32276
|
+
|
32277
|
+
Projected cost data is only available for the current month and becomes available
|
32278
|
+
around the 12th of the month.
|
32279
|
+
|
32280
|
+
This endpoint requires the usage_read authorization scope.'
|
32281
|
+
operationId: GetProjectedCost
|
32282
|
+
parameters:
|
32283
|
+
- description: String to specify whether cost is broken down at a parent-org
|
32284
|
+
level or at the sub-org level. Available views are `summary` and `sub-org`.
|
32285
|
+
Defaults to `summary`.
|
32286
|
+
in: query
|
32287
|
+
name: view
|
32288
|
+
required: false
|
32289
|
+
schema:
|
32290
|
+
type: string
|
32291
|
+
responses:
|
32292
|
+
'200':
|
32293
|
+
content:
|
32294
|
+
application/json;datetime-format=rfc3339:
|
32295
|
+
schema:
|
32296
|
+
$ref: '#/components/schemas/ProjectedCostResponse'
|
32297
|
+
description: OK
|
32298
|
+
'400':
|
32299
|
+
content:
|
32300
|
+
application/json;datetime-format=rfc3339:
|
32301
|
+
schema:
|
32302
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
32303
|
+
description: Bad Request
|
32304
|
+
'403':
|
32305
|
+
content:
|
32306
|
+
application/json;datetime-format=rfc3339:
|
32307
|
+
schema:
|
32308
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
32309
|
+
description: Forbidden - User is not authorized
|
32310
|
+
'429':
|
32311
|
+
content:
|
32312
|
+
application/json;datetime-format=rfc3339:
|
32313
|
+
schema:
|
32314
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
32315
|
+
description: Too many requests
|
32316
|
+
security:
|
32317
|
+
- apiKeyAuth: []
|
32318
|
+
appKeyAuth: []
|
32319
|
+
- AuthZ:
|
32320
|
+
- usage_read
|
32321
|
+
summary: Get projected cost across your account
|
32322
|
+
tags:
|
32323
|
+
- Usage Metering
|
29938
32324
|
/api/v2/user_invitations:
|
29939
32325
|
post:
|
29940
32326
|
description: Sends emails to one or more users inviting them to join the organization.
|
@@ -30426,6 +32812,9 @@ tags:
|
|
30426
32812
|
name: CI Visibility Pipelines
|
30427
32813
|
- description: Search or aggregate your CI Visibility test events over HTTP.
|
30428
32814
|
name: CI Visibility Tests
|
32815
|
+
- description: The Cloud Cost Management API allows you to setup, edit and delete
|
32816
|
+
cloud cost management accounts for AWS & Azure.
|
32817
|
+
name: Cloud Cost Management
|
30429
32818
|
- description: Workload activity security rules for generating events using the Datadog
|
30430
32819
|
security Agent.
|
30431
32820
|
name: Cloud Workload Security
|
@@ -30440,6 +32829,8 @@ tags:
|
|
30440
32829
|
name: Container Images
|
30441
32830
|
- description: The Containers API allows you to query container data for your organization.
|
30442
32831
|
name: Containers
|
32832
|
+
- description: Send events for DORA Metrics to measure and improve software delivery.
|
32833
|
+
name: DORA Metrics
|
30443
32834
|
- description: 'Interact with your dashboard lists through the API to
|
30444
32835
|
|
30445
32836
|
organize, find, and share all of your dashboards with your team and
|
@@ -30549,6 +32940,9 @@ tags:
|
|
30549
32940
|
description: Find out more at
|
30550
32941
|
url: https://docs.datadoghq.com/monitors/create/types/
|
30551
32942
|
name: Monitors
|
32943
|
+
- description: Configure your Datadog Okta integration directly through the Datadog
|
32944
|
+
API.
|
32945
|
+
name: Okta Integration
|
30552
32946
|
- description: 'Configure your [Datadog Opsgenie integration](https://docs.datadoghq.com/integrations/opsgenie/)
|
30553
32947
|
|
30554
32948
|
directly through the Datadog API.'
|