datadog_api_client 2.21.0 → 2.23.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (155) hide show
  1. checksums.yaml +4 -4
  2. data/.apigentools-info +4 -4
  3. data/.generator/schemas/v1/openapi.yaml +308 -695
  4. data/.generator/schemas/v2/openapi.yaml +664 -185
  5. data/.github/workflows/prepare_release.yml +2 -2
  6. data/.github/workflows/publish.yml +2 -2
  7. data/.github/workflows/release.yml +2 -2
  8. data/.github/workflows/test.yml +1 -1
  9. data/CHANGELOG.md +41 -0
  10. data/Gemfile +1 -1
  11. data/examples/v1/aws-integration/CreateAWSAccount.rb +1 -1
  12. data/examples/v1/aws-integration/CreateNewAWSExternalID.rb +1 -0
  13. data/examples/v1/aws-integration/UpdateAWSAccount.rb +1 -1
  14. data/examples/v1/synthetics/CreateSyntheticsAPITest_1241981394.rb +118 -0
  15. data/examples/v1/synthetics/CreateSyntheticsAPITest_1487281163.rb +9 -0
  16. data/examples/v1/synthetics/CreateSyntheticsAPITest_960766374.rb +8 -0
  17. data/examples/v1/synthetics/UpdateAPITest.rb +8 -0
  18. data/examples/v1/synthetics/UpdateBrowserTest.rb +3 -0
  19. data/examples/v2/apm-retention-filters/UpdateApmRetentionFilter.rb +2 -2
  20. data/examples/v2/authn-mappings/CreateAuthNMapping.rb +1 -1
  21. data/examples/v2/authn-mappings/UpdateAuthNMapping.rb +1 -1
  22. data/examples/v2/{cloud-workload-security → csm-threats}/CreateCSMThreatsAgentRule.rb +2 -2
  23. data/examples/v2/{cloud-workload-security → csm-threats}/CreateCloudWorkloadSecurityAgentRule.rb +2 -2
  24. data/examples/v2/{cloud-workload-security → csm-threats}/DeleteCSMThreatsAgentRule.rb +1 -1
  25. data/examples/v2/{cloud-workload-security → csm-threats}/DeleteCloudWorkloadSecurityAgentRule.rb +1 -1
  26. data/examples/v2/{cloud-workload-security → csm-threats}/DownloadCSMThreatsPolicy.rb +1 -1
  27. data/examples/v2/{cloud-workload-security → csm-threats}/DownloadCloudWorkloadPolicyFile.rb +1 -1
  28. data/examples/v2/{cloud-workload-security → csm-threats}/GetCSMThreatsAgentRule.rb +1 -1
  29. data/examples/v2/{cloud-workload-security → csm-threats}/GetCloudWorkloadSecurityAgentRule.rb +1 -1
  30. data/examples/v2/{cloud-workload-security → csm-threats}/ListCSMThreatsAgentRules.rb +1 -1
  31. data/examples/v2/{cloud-workload-security → csm-threats}/ListCloudWorkloadSecurityAgentRules.rb +1 -1
  32. data/examples/v2/{cloud-workload-security → csm-threats}/UpdateCSMThreatsAgentRule.rb +1 -1
  33. data/examples/v2/{cloud-workload-security → csm-threats}/UpdateCloudWorkloadSecurityAgentRule.rb +1 -1
  34. data/examples/v2/gcp-integration/CreateGCPSTSAccount.rb +1 -1
  35. data/examples/v2/gcp-integration/CreateGCPSTSAccount_109518525.rb +1 -1
  36. data/examples/v2/gcp-integration/CreateGCPSTSAccount_130557025.rb +1 -1
  37. data/examples/v2/gcp-integration/CreateGCPSTSAccount_194782945.rb +1 -1
  38. data/examples/v2/gcp-integration/CreateGCPSTSAccount_2597004741.rb +1 -1
  39. data/examples/v2/gcp-integration/CreateGCPSTSAccount_4235664992.rb +1 -1
  40. data/examples/v2/gcp-integration/UpdateGCPSTSAccount.rb +1 -1
  41. data/examples/v2/gcp-integration/UpdateGCPSTSAccount_2241994060.rb +1 -1
  42. data/examples/v2/gcp-integration/UpdateGCPSTSAccount_3205636354.rb +1 -1
  43. data/examples/v2/logs-custom-destinations/UpdateLogsCustomDestination.rb +4 -0
  44. data/examples/v2/metrics/QueryScalarData_3112571352.rb +2 -2
  45. data/examples/v2/metrics/QueryTimeseriesData_301142940.rb +3 -3
  46. data/examples/v2/roles/CreateRole.rb +14 -2
  47. data/examples/v2/roles/CreateRole_3862893229.rb +27 -0
  48. data/examples/v2/security-monitoring/CreateSecurityMonitoringSuppression.rb +1 -1
  49. data/examples/v2/security-monitoring/CreateSecurityMonitoringSuppression_3192265332.rb +19 -0
  50. data/examples/v2/security-monitoring/ValidateSecurityMonitoringRule.rb +42 -0
  51. data/examples/v2/service-definition/CreateOrUpdateServiceDefinitions.rb +4 -0
  52. data/examples/v2/service-level-objectives/CreateSLOReportJob.rb +20 -0
  53. data/examples/v2/service-level-objectives/GetSLOReport.rb +8 -0
  54. data/examples/v2/service-level-objectives/GetSLOReportJobStatus.rb +11 -0
  55. data/lib/datadog_api_client/configuration.rb +3 -0
  56. data/lib/datadog_api_client/inflector.rb +26 -8
  57. data/lib/datadog_api_client/v1/api/authentication_api.rb +1 -1
  58. data/lib/datadog_api_client/v1/api/aws_integration_api.rb +1 -1
  59. data/lib/datadog_api_client/v1/api/logs_indexes_api.rb +1 -1
  60. data/lib/datadog_api_client/v1/api/logs_pipelines_api.rb +3 -3
  61. data/lib/datadog_api_client/v1/api/usage_metering_api.rb +112 -135
  62. data/lib/datadog_api_client/v1/api/users_api.rb +1 -1
  63. data/lib/datadog_api_client/v1/models/aws_account.rb +12 -2
  64. data/lib/datadog_api_client/v1/models/hourly_usage_attribution_usage_type.rb +3 -0
  65. data/lib/datadog_api_client/v1/models/monitor_options.rb +4 -1
  66. data/lib/datadog_api_client/v1/models/monthly_usage_attribution_supported_metrics.rb +6 -0
  67. data/lib/datadog_api_client/v1/models/monthly_usage_attribution_values.rb +61 -1
  68. data/lib/datadog_api_client/v1/models/series.rb +1 -1
  69. data/lib/datadog_api_client/v1/models/service_level_objective.rb +2 -1
  70. data/lib/datadog_api_client/v1/models/service_level_objective_request.rb +2 -1
  71. data/lib/datadog_api_client/v1/models/slo_history_monitor.rb +7 -1
  72. data/lib/datadog_api_client/v1/models/slo_history_sli_data.rb +8 -1
  73. data/lib/datadog_api_client/v1/models/slo_overall_statuses.rb +2 -1
  74. data/lib/datadog_api_client/v1/models/slo_response_data.rb +2 -1
  75. data/lib/datadog_api_client/v1/models/slo_threshold.rb +2 -1
  76. data/lib/datadog_api_client/v1/models/slo_time_slice_condition.rb +14 -2
  77. data/lib/datadog_api_client/v1/models/slo_time_slice_interval.rb +29 -0
  78. data/lib/datadog_api_client/v1/models/slo_time_slice_spec.rb +1 -1
  79. data/lib/datadog_api_client/v1/models/slo_timeframe.rb +2 -1
  80. data/lib/datadog_api_client/v1/models/synthetics_api_test_config.rb +14 -4
  81. data/lib/datadog_api_client/v1/models/synthetics_assertion.rb +1 -0
  82. data/lib/datadog_api_client/v1/models/synthetics_assertion_json_schema_meta_schema.rb +27 -0
  83. data/lib/datadog_api_client/v1/models/synthetics_assertion_json_schema_operator.rb +26 -0
  84. data/lib/datadog_api_client/v1/models/synthetics_assertion_json_schema_target.rb +129 -0
  85. data/lib/datadog_api_client/v1/models/{usage_attribution_metadata.rb → synthetics_assertion_json_schema_target_target.rb} +19 -21
  86. data/lib/datadog_api_client/v1/models/synthetics_test_request.rb +13 -1
  87. data/lib/datadog_api_client/v1/models/synthetics_test_request_body_file.rb +175 -0
  88. data/lib/datadog_api_client/v1/models/synthetics_test_request_body_type.rb +2 -0
  89. data/lib/datadog_api_client/v1/models/usage_billable_summary_keys.rb +11 -1
  90. data/lib/datadog_api_client/v2/api/apm_retention_filters_api.rb +8 -2
  91. data/lib/datadog_api_client/v2/api/authn_mappings_api.rb +2 -2
  92. data/lib/datadog_api_client/v2/api/case_management_api.rb +17 -16
  93. data/lib/datadog_api_client/v2/api/cloud_cost_management_api.rb +10 -10
  94. data/lib/datadog_api_client/v2/api/{cloud_workload_security_api.rb → csm_threats_api.rb} +35 -35
  95. data/lib/datadog_api_client/v2/api/events_api.rb +1 -1
  96. data/lib/datadog_api_client/v2/api/ip_allowlist_api.rb +2 -2
  97. data/lib/datadog_api_client/v2/api/logs_api.rb +1 -1
  98. data/lib/datadog_api_client/v2/api/logs_archives_api.rb +4 -4
  99. data/lib/datadog_api_client/v2/api/logs_metrics_api.rb +2 -2
  100. data/lib/datadog_api_client/v2/api/metrics_api.rb +4 -4
  101. data/lib/datadog_api_client/v2/api/restriction_policies_api.rb +2 -2
  102. data/lib/datadog_api_client/v2/api/security_monitoring_api.rb +69 -1
  103. data/lib/datadog_api_client/v2/api/service_level_objectives_api.rb +245 -0
  104. data/lib/datadog_api_client/v2/api/spans_api.rb +3 -3
  105. data/lib/datadog_api_client/v2/api/usage_metering_api.rb +22 -4
  106. data/lib/datadog_api_client/v2/models/authn_mapping_create_data.rb +1 -1
  107. data/lib/datadog_api_client/v2/models/authn_mapping_create_relationships.rb +37 -54
  108. data/lib/datadog_api_client/v2/models/authn_mapping_included.rb +2 -1
  109. data/lib/datadog_api_client/v2/models/authn_mapping_relationship_to_role.rb +98 -0
  110. data/lib/datadog_api_client/v2/models/authn_mapping_relationship_to_team.rb +98 -0
  111. data/lib/datadog_api_client/v2/models/authn_mapping_relationships.rb +14 -4
  112. data/lib/datadog_api_client/v2/models/authn_mapping_team.rb +100 -0
  113. data/lib/datadog_api_client/v2/models/authn_mapping_team_attributes.rb +212 -0
  114. data/lib/datadog_api_client/v2/models/authn_mapping_update_data.rb +1 -1
  115. data/lib/datadog_api_client/v2/models/authn_mapping_update_relationships.rb +37 -54
  116. data/lib/datadog_api_client/v2/models/custom_destination_type.rb +1 -1
  117. data/lib/datadog_api_client/v2/models/dora_deployment_request_attributes.rb +1 -1
  118. data/lib/datadog_api_client/v2/models/logs_query_filter.rb +1 -1
  119. data/lib/datadog_api_client/v2/models/logs_storage_tier.rb +2 -1
  120. data/lib/datadog_api_client/v2/models/metric_series.rb +1 -1
  121. data/lib/datadog_api_client/v2/models/relationship_to_team.rb +80 -0
  122. data/lib/datadog_api_client/{v1/models/usage_attribution_response.rb → v2/models/relationship_to_team_data.rb} +21 -23
  123. data/lib/datadog_api_client/v2/models/retention_filter_create_response.rb +80 -0
  124. data/lib/datadog_api_client/v2/models/retention_filter_response.rb +1 -1
  125. data/lib/datadog_api_client/v2/models/retention_filter_update_attributes.rb +183 -0
  126. data/lib/datadog_api_client/v2/models/retention_filter_update_data.rb +1 -1
  127. data/lib/datadog_api_client/v2/models/security_monitoring_rule_update_payload.rb +1 -1
  128. data/lib/datadog_api_client/v2/models/security_monitoring_signal_rule_create_payload.rb +1 -1
  129. data/lib/datadog_api_client/v2/models/security_monitoring_signal_rule_response.rb +1 -1
  130. data/lib/datadog_api_client/v2/models/security_monitoring_standard_rule_create_payload.rb +1 -1
  131. data/lib/datadog_api_client/v2/models/security_monitoring_standard_rule_response.rb +14 -2
  132. data/lib/datadog_api_client/v2/models/security_monitoring_suppression_attributes.rb +11 -1
  133. data/lib/datadog_api_client/v2/models/security_monitoring_suppression_create_attributes.rb +13 -14
  134. data/lib/datadog_api_client/v2/models/security_monitoring_suppression_update_attributes.rb +11 -1
  135. data/lib/datadog_api_client/v2/models/service_definition_v2_dot2.rb +13 -1
  136. data/lib/datadog_api_client/v2/models/slo_report_create_request.rb +98 -0
  137. data/lib/datadog_api_client/v2/models/slo_report_create_request_attributes.rb +160 -0
  138. data/lib/datadog_api_client/{v1/models/usage_attribution_pagination.rb → v2/models/slo_report_create_request_data.rb} +29 -51
  139. data/lib/datadog_api_client/v2/models/slo_report_interval.rb +27 -0
  140. data/lib/datadog_api_client/v2/models/slo_report_post_response.rb +80 -0
  141. data/lib/datadog_api_client/v2/models/slo_report_post_response_data.rb +90 -0
  142. data/lib/datadog_api_client/v2/models/slo_report_status.rb +29 -0
  143. data/lib/datadog_api_client/v2/models/slo_report_status_get_response.rb +80 -0
  144. data/lib/datadog_api_client/v2/models/slo_report_status_get_response_attributes.rb +80 -0
  145. data/lib/datadog_api_client/v2/models/slo_report_status_get_response_data.rb +100 -0
  146. data/lib/datadog_api_client/v2/models/timeseries_response_series.rb +8 -0
  147. data/lib/datadog_api_client/v2/models/user_team_included.rb +2 -1
  148. data/lib/datadog_api_client/v2/models/user_teams_response.rb +13 -1
  149. data/lib/datadog_api_client/version.rb +1 -1
  150. metadata +70 -46
  151. data/examples/v1/usage-metering/GetUsageAttribution.rb +0 -9
  152. data/lib/datadog_api_client/v1/models/usage_attribution_body.rb +0 -152
  153. data/lib/datadog_api_client/v1/models/usage_attribution_sort.rb +0 -63
  154. data/lib/datadog_api_client/v1/models/usage_attribution_supported_metrics.rb +0 -74
  155. data/lib/datadog_api_client/v1/models/usage_attribution_values.rb +0 -590
@@ -90,6 +90,12 @@ components:
90
90
  description: Regions to exclude.
91
91
  type: string
92
92
  type: array
93
+ extended_resource_collection_enabled:
94
+ default: false
95
+ description: Whether Datadog collects additional attributes and configuration
96
+ information about the resources in your AWS account. Required for `cspm_resource_collection`.
97
+ example: true
98
+ type: boolean
93
99
  filter_tags:
94
100
  description: 'The array of EC2 tags (in the form `key:value`) defines a
95
101
  filter that Datadog uses when collecting metrics from EC2.
@@ -128,8 +134,9 @@ components:
128
134
  type: boolean
129
135
  resource_collection_enabled:
130
136
  default: false
131
- description: Whether Datadog collects a standard set of resources from your
132
- AWS account.
137
+ deprecated: true
138
+ description: Deprecated in favor of 'extended_resource_collection_enabled'.
139
+ Whether Datadog collects a standard set of resources from your AWS account.
133
140
  example: true
134
141
  type: boolean
135
142
  role_name:
@@ -4110,6 +4117,7 @@ components:
4110
4117
  - estimated_rum_sessions_usage
4111
4118
  - fargate_usage
4112
4119
  - functions_usage
4120
+ - incident_management_monthly_active_users_usage
4113
4121
  - indexed_spans_usage
4114
4122
  - infra_host_usage
4115
4123
  - ingested_logs_bytes_usage
@@ -4118,6 +4126,7 @@ components:
4118
4126
  - lambda_traced_invocations_usage
4119
4127
  - logs_indexed_15day_usage
4120
4128
  - logs_indexed_180day_usage
4129
+ - logs_indexed_1day_usage
4121
4130
  - logs_indexed_30day_usage
4122
4131
  - logs_indexed_360day_usage
4123
4132
  - logs_indexed_3day_usage
@@ -4131,6 +4140,7 @@ components:
4131
4140
  - npm_host_usage
4132
4141
  - obs_pipeline_bytes_usage
4133
4142
  - obs_pipelines_vcpu_usage
4143
+ - online_archive_usage
4134
4144
  - profiled_container_usage
4135
4145
  - profiled_fargate_usage
4136
4146
  - profiled_host_usage
@@ -4178,6 +4188,7 @@ components:
4178
4188
  - ESTIMATED_RUM_SESSIONS_USAGE
4179
4189
  - FARGATE_USAGE
4180
4190
  - FUNCTIONS_USAGE
4191
+ - INCIDENT_MANAGEMENT_MONTHLY_ACTIVE_USERS_USAGE
4181
4192
  - INDEXED_SPANS_USAGE
4182
4193
  - INFRA_HOST_USAGE
4183
4194
  - INGESTED_LOGS_BYTES_USAGE
@@ -4186,6 +4197,7 @@ components:
4186
4197
  - LAMBDA_TRACED_INVOCATIONS_USAGE
4187
4198
  - LOGS_INDEXED_15DAY_USAGE
4188
4199
  - LOGS_INDEXED_180DAY_USAGE
4200
+ - LOGS_INDEXED_1DAY_USAGE
4189
4201
  - LOGS_INDEXED_30DAY_USAGE
4190
4202
  - LOGS_INDEXED_360DAY_USAGE
4191
4203
  - LOGS_INDEXED_3DAY_USAGE
@@ -4199,6 +4211,7 @@ components:
4199
4211
  - NPM_HOST_USAGE
4200
4212
  - OBS_PIPELINE_BYTES_USAGE
4201
4213
  - OBS_PIPELINE_VCPU_USAGE
4214
+ - ONLINE_ARCHIVE_USAGE
4202
4215
  - PROFILED_CONTAINER_USAGE
4203
4216
  - PROFILED_FARGATE_USAGE
4204
4217
  - PROFILED_HOST_USAGE
@@ -7063,8 +7076,13 @@ components:
7063
7076
  nullable: true
7064
7077
  type: integer
7065
7078
  renotify_statuses:
7066
- description: The types of monitor statuses for which re-notification messages
7079
+ description: 'The types of monitor statuses for which re-notification messages
7067
7080
  are sent.
7081
+
7082
+ Default: **null** if `renotify_interval` is **null**.
7083
+
7084
+ If `renotify_interval` is set, defaults to renotify on `Alert` and `No
7085
+ Data`.'
7068
7086
  items:
7069
7087
  $ref: '#/components/schemas/MonitorRenotifyStatusType'
7070
7088
  nullable: true
@@ -7073,7 +7091,7 @@ components:
7073
7091
  description: "A Boolean indicating whether this monitor needs a full window
7074
7092
  of data before it\u2019s evaluated.\nWe highly recommend you set this
7075
7093
  to `false` for sparse metrics,\notherwise some evaluations are skipped.
7076
- Default is false."
7094
+ Default is false. This setting only applies to\nmetric monitors."
7077
7095
  type: boolean
7078
7096
  scheduling_options:
7079
7097
  $ref: '#/components/schemas/MonitorOptionsSchedulingOptions'
@@ -7816,6 +7834,8 @@ components:
7816
7834
  - fargate_percentage
7817
7835
  - functions_usage
7818
7836
  - functions_percentage
7837
+ - incident_management_monthly_active_users_usage
7838
+ - incident_management_monthly_active_users_percentage
7819
7839
  - infra_host_usage
7820
7840
  - infra_host_percentage
7821
7841
  - invocations_usage
@@ -7832,6 +7852,8 @@ components:
7832
7852
  - obs_pipeline_bytes_percentage
7833
7853
  - obs_pipelines_vcpu_usage
7834
7854
  - obs_pipelines_vcpu_percentage
7855
+ - online_archive_usage
7856
+ - online_archive_percentage
7835
7857
  - profiled_container_usage
7836
7858
  - profiled_container_percentage
7837
7859
  - profiled_fargate_usage
@@ -7880,6 +7902,8 @@ components:
7880
7902
  - logs_indexed_7day_percentage
7881
7903
  - logs_indexed_3day_usage
7882
7904
  - logs_indexed_3day_percentage
7905
+ - logs_indexed_1day_usage
7906
+ - logs_indexed_1day_percentage
7883
7907
  - rum_replay_sessions_usage
7884
7908
  - rum_replay_sessions_percentage
7885
7909
  - rum_browser_mobile_sessions_usage
@@ -7947,6 +7971,8 @@ components:
7947
7971
  - FARGATE_PERCENTAGE
7948
7972
  - FUNCTIONS_USAGE
7949
7973
  - FUNCTIONS_PERCENTAGE
7974
+ - INCIDENT_MANAGEMENT_MONTHLY_ACTIVE_USERS_USAGE
7975
+ - INCIDENT_MANAGEMENT_MONTHLY_ACTIVE_USERS_PERCENTAGE
7950
7976
  - INFRA_HOST_USAGE
7951
7977
  - INFRA_HOST_PERCENTAGE
7952
7978
  - INVOCATIONS_USAGE
@@ -7963,6 +7989,8 @@ components:
7963
7989
  - OBS_PIPELINE_BYTES_PERCENTAGE
7964
7990
  - OBS_PIPELINES_VCPU_USAGE
7965
7991
  - OBS_PIPELINES_VCPU_PERCENTAGE
7992
+ - ONLINE_ARCHIVE_USAGE
7993
+ - ONLINE_ARCHIVE_PERCENTAGE
7966
7994
  - PROFILED_CONTAINER_USAGE
7967
7995
  - PROFILED_CONTAINER_PERCENTAGE
7968
7996
  - PROFILED_FARGATE_USAGE
@@ -8011,6 +8039,8 @@ components:
8011
8039
  - LOGS_INDEXED_7DAY_PERCENTAGE
8012
8040
  - LOGS_INDEXED_3DAY_USAGE
8013
8041
  - LOGS_INDEXED_3DAY_PERCENTAGE
8042
+ - LOGS_INDEXED_1DAY_USAGE
8043
+ - LOGS_INDEXED_1DAY_PERCENTAGE
8014
8044
  - RUM_REPLAY_SESSIONS_USAGE
8015
8045
  - RUM_REPLAY_SESSIONS_PERCENTAGE
8016
8046
  - RUM_BROWSER_MOBILE_SESSIONS_USAGE
@@ -8286,6 +8316,15 @@ components:
8286
8316
  description: The Lambda function usage by tag(s).
8287
8317
  format: double
8288
8318
  type: number
8319
+ incident_management_monthly_active_users_percentage:
8320
+ description: The percentage of Incident Management monthly active users
8321
+ usage by tag(s).
8322
+ format: double
8323
+ type: number
8324
+ incident_management_monthly_active_users_usage:
8325
+ description: The Incident Management monthly active users usage by tag(s).
8326
+ format: double
8327
+ type: number
8289
8328
  indexed_spans_percentage:
8290
8329
  description: The percentage of APM Indexed Spans usage by tag(s).
8291
8330
  format: double
@@ -8352,6 +8391,14 @@ components:
8352
8391
  description: The total Indexed Logs (180-day Retention) usage by tag(s).
8353
8392
  format: double
8354
8393
  type: number
8394
+ logs_indexed_1day_percentage:
8395
+ description: The percentage of Indexed Logs (1-day Retention) usage by tag(s).
8396
+ format: double
8397
+ type: number
8398
+ logs_indexed_1day_usage:
8399
+ description: The total Indexed Logs (1-day Retention) usage by tag(s).
8400
+ format: double
8401
+ type: number
8355
8402
  logs_indexed_30day_percentage:
8356
8403
  description: The percentage of Indexed Logs (30-day Retention) usage by
8357
8404
  tag(s).
@@ -8465,6 +8512,14 @@ components:
8465
8512
  description: The observability pipeline per core usage by tag(s).
8466
8513
  format: double
8467
8514
  type: number
8515
+ online_archive_percentage:
8516
+ description: The percentage of online archive usage by tag(s).
8517
+ format: double
8518
+ type: number
8519
+ online_archive_usage:
8520
+ description: The online archive usage by tag(s).
8521
+ format: double
8522
+ type: number
8468
8523
  profiled_container_percentage:
8469
8524
  description: The percentage of profiled container usage by tag(s).
8470
8525
  format: double
@@ -10606,9 +10661,24 @@ components:
10606
10661
  example: name
10607
10662
  type: string
10608
10663
  history:
10609
- description: For `monitor` based SLOs, this includes the aggregated history
10610
- as arrays that include timeseries and uptime data where `0=monitor` is
10611
- in `OK` state and `1=monitor` is in `alert` state.
10664
+ description: 'The state transition history for the monitor. It is represented
10665
+ as
10666
+
10667
+ an array of pairs. Each pair is an array containing the timestamp of the
10668
+ transition
10669
+
10670
+ as an integer in Unix epoch format in the first element, and the state
10671
+ as an integer in the
10672
+
10673
+ second element. An integer value of `0` for state means uptime, `1` means
10674
+ downtime, and `2` means no data.
10675
+
10676
+ Periods of no data are counted either as uptime or downtime depending
10677
+ on monitor settings.
10678
+
10679
+ See [SLO documentatio](https://docs.datadoghq.com/service_management/service_level_objectives/monitor/#missing-data)
10680
+
10681
+ for detailed information.'
10612
10682
  example:
10613
10683
  - - 1579212382
10614
10684
  - 0
@@ -10788,9 +10858,26 @@ components:
10788
10858
  example: name
10789
10859
  type: string
10790
10860
  history:
10791
- description: For `monitor` based SLOs, this includes the aggregated history
10792
- as arrays that include timeseries and uptime data where `0=monitor` is
10793
- in `OK` state and `1=monitor` is in `alert` state.
10861
+ description: 'The state transition history for `monitor` or `time-slice`
10862
+ SLOs. It is represented as
10863
+
10864
+ an array of pairs. Each pair is an array containing the timestamp of the
10865
+ transition
10866
+
10867
+ as an integer in Unix epoch format in the first element, and the state
10868
+ as an integer in the
10869
+
10870
+ second element. An integer value of `0` for state means uptime, `1` means
10871
+ downtime, and `2` means no data.
10872
+
10873
+ Periods of no data count as uptime in time-slice SLOs, while for monitor
10874
+ SLOs, no data is counted
10875
+
10876
+ either as uptime or downtime depending on monitor settings. See
10877
+
10878
+ [SLO documentation](https://docs.datadoghq.com/service_management/service_level_objectives/monitor/#missing-data)
10879
+
10880
+ for detailed information.'
10794
10881
  example:
10795
10882
  - - 1579212382
10796
10883
  - 0
@@ -11341,7 +11428,8 @@ components:
11341
11428
  description: 'The time-slice condition, composed of 3 parts: 1. the metric timeseries
11342
11429
  query, 2. the comparator,
11343
11430
 
11344
- and 3. the threshold.'
11431
+ and 3. the threshold. Optionally, a fourth part, the query interval, can be
11432
+ provided.'
11345
11433
  example:
11346
11434
  comparator: <
11347
11435
  query:
@@ -11360,6 +11448,8 @@ components:
11360
11448
  $ref: '#/components/schemas/SLOTimeSliceComparator'
11361
11449
  query:
11362
11450
  $ref: '#/components/schemas/SLOTimeSliceQuery'
11451
+ query_interval_seconds:
11452
+ $ref: '#/components/schemas/SLOTimeSliceInterval'
11363
11453
  threshold:
11364
11454
  description: The threshold value to which each SLI value will be compared.
11365
11455
  example: 5
@@ -11370,6 +11460,22 @@ components:
11370
11460
  - threshold
11371
11461
  - query
11372
11462
  type: object
11463
+ SLOTimeSliceInterval:
11464
+ description: 'The interval used when querying data, which defines the size of
11465
+ a time slice.
11466
+
11467
+ Two values are allowed: 60 (1 minute) and 300 (5 minutes).
11468
+
11469
+ If not provided, the value defaults to 300 (5 minutes).'
11470
+ enum:
11471
+ - 60
11472
+ - 300
11473
+ example: 300
11474
+ format: int32
11475
+ type: integer
11476
+ x-enum-varnames:
11477
+ - ONE_MINUTE
11478
+ - FIVE_MINUTES
11373
11479
  SLOTimeSliceQuery:
11374
11480
  description: The queries and formula used to calculate the SLI value.
11375
11481
  example:
@@ -11424,7 +11530,10 @@ components:
11424
11530
  - time_slice
11425
11531
  type: object
11426
11532
  SLOTimeframe:
11427
- description: The SLO time window options.
11533
+ description: 'The SLO time window options. Note that "custom" is not a valid
11534
+ option for creating
11535
+
11536
+ or updating SLOs. It is only used when querying SLO history over custom timeframes.'
11428
11537
  enum:
11429
11538
  - 7d
11430
11539
  - 30d
@@ -12090,7 +12199,7 @@ components:
12090
12199
  interval:
12091
12200
  default: null
12092
12201
  description: If the type of the metric is rate or count, define the corresponding
12093
- interval.
12202
+ interval in seconds.
12094
12203
  example: 20
12095
12204
  format: int64
12096
12205
  nullable: true
@@ -13386,6 +13495,10 @@ components:
13386
13495
  items:
13387
13496
  $ref: '#/components/schemas/SyntheticsAPIStep'
13388
13497
  type: array
13498
+ variablesFromScript:
13499
+ description: Variables defined from JavaScript code.
13500
+ example: dd.variable.set("FOO", "foo")
13501
+ type: string
13389
13502
  type: object
13390
13503
  SyntheticsAPITestResultData:
13391
13504
  description: Object containing results for your Synthetic API test.
@@ -13563,6 +13676,7 @@ components:
13563
13676
  oneOf:
13564
13677
  - $ref: '#/components/schemas/SyntheticsAssertionTarget'
13565
13678
  - $ref: '#/components/schemas/SyntheticsAssertionJSONPathTarget'
13679
+ - $ref: '#/components/schemas/SyntheticsAssertionJSONSchemaTarget'
13566
13680
  - $ref: '#/components/schemas/SyntheticsAssertionXPathTarget'
13567
13681
  SyntheticsAssertionJSONPathOperator:
13568
13682
  description: Assertion operator to apply.
@@ -13600,6 +13714,45 @@ components:
13600
13714
  targetValue:
13601
13715
  description: The path target value to compare to.
13602
13716
  type: object
13717
+ SyntheticsAssertionJSONSchemaMetaSchema:
13718
+ description: The JSON Schema meta-schema version used in the assertion.
13719
+ enum:
13720
+ - draft-07
13721
+ - draft-06
13722
+ type: string
13723
+ x-enum-varnames:
13724
+ - DRAFT_07
13725
+ - DRAFT_06
13726
+ SyntheticsAssertionJSONSchemaOperator:
13727
+ description: Assertion operator to apply.
13728
+ enum:
13729
+ - validatesJSONSchema
13730
+ example: validatesJSONSchema
13731
+ type: string
13732
+ x-enum-varnames:
13733
+ - VALIDATES_JSON_SCHEMA
13734
+ SyntheticsAssertionJSONSchemaTarget:
13735
+ description: An assertion for the `validatesJSONSchema` operator.
13736
+ properties:
13737
+ operator:
13738
+ $ref: '#/components/schemas/SyntheticsAssertionJSONSchemaOperator'
13739
+ target:
13740
+ $ref: '#/components/schemas/SyntheticsAssertionJSONSchemaTargetTarget'
13741
+ type:
13742
+ $ref: '#/components/schemas/SyntheticsAssertionType'
13743
+ required:
13744
+ - type
13745
+ - operator
13746
+ type: object
13747
+ SyntheticsAssertionJSONSchemaTargetTarget:
13748
+ description: Composed target for `validatesJSONSchema` operator.
13749
+ properties:
13750
+ jsonSchema:
13751
+ description: The JSON Schema to assert.
13752
+ type: string
13753
+ metaSchema:
13754
+ $ref: '#/components/schemas/SyntheticsAssertionJSONSchemaMetaSchema'
13755
+ type: object
13603
13756
  SyntheticsAssertionOperator:
13604
13757
  description: Assertion operator to apply.
13605
13758
  enum:
@@ -15818,6 +15971,11 @@ components:
15818
15971
  maximum: 65535
15819
15972
  minimum: 1
15820
15973
  type: integer
15974
+ files:
15975
+ description: Files to be used as part of the request in the test.
15976
+ items:
15977
+ $ref: '#/components/schemas/SyntheticsTestRequestBodyFile'
15978
+ type: array
15821
15979
  follow_redirects:
15822
15980
  description: Specifies whether or not the request follows redirects.
15823
15981
  type: boolean
@@ -15884,6 +16042,32 @@ components:
15884
16042
  example: https://example.com
15885
16043
  type: string
15886
16044
  type: object
16045
+ SyntheticsTestRequestBodyFile:
16046
+ description: Object describing a file to be used as part of the request in the
16047
+ test.
16048
+ properties:
16049
+ bucketKey:
16050
+ description: Bucket key of the file.
16051
+ type: string
16052
+ content:
16053
+ description: Content of the file.
16054
+ maxLength: 3145728
16055
+ type: string
16056
+ name:
16057
+ description: Name of the file.
16058
+ maxLength: 1500
16059
+ type: string
16060
+ size:
16061
+ description: Size of the file.
16062
+ format: int64
16063
+ maximum: 3145728
16064
+ minimum: 1
16065
+ type: integer
16066
+ type:
16067
+ description: Type of the file.
16068
+ maxLength: 1500
16069
+ type: string
16070
+ type: object
15887
16071
  SyntheticsTestRequestBodyType:
15888
16072
  description: Type of the request body.
15889
16073
  enum:
@@ -15893,6 +16077,8 @@ components:
15893
16077
  - text/html
15894
16078
  - application/x-www-form-urlencoded
15895
16079
  - graphql
16080
+ - application/octet-stream
16081
+ - multipart/form-data
15896
16082
  example: text/plain
15897
16083
  type: string
15898
16084
  x-enum-varnames:
@@ -15902,6 +16088,8 @@ components:
15902
16088
  - TEXT_HTML
15903
16089
  - APPLICATION_X_WWW_FORM_URLENCODED
15904
16090
  - GRAPHQL
16091
+ - APPLICATION_OCTET_STREAM
16092
+ - MULTIPART_FORM_DATA
15905
16093
  SyntheticsTestRequestCertificate:
15906
16094
  description: Client certificate to use when performing the test request.
15907
16095
  properties:
@@ -16819,270 +17007,6 @@ components:
16819
17007
  format: double
16820
17008
  type: number
16821
17009
  type: object
16822
- UsageAttributionBody:
16823
- description: Usage Summary by tag for a given organization.
16824
- properties:
16825
- month:
16826
- description: 'Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM].'
16827
- format: date-time
16828
- type: string
16829
- org_name:
16830
- description: The name of the organization.
16831
- type: string
16832
- public_id:
16833
- description: The organization public ID.
16834
- type: string
16835
- tag_config_source:
16836
- description: The source of the usage attribution tag configuration and the
16837
- selected tags in the format `<source_org_name>:::<selected tag 1>///<selected
16838
- tag 2>///<selected tag 3>`.
16839
- type: string
16840
- tags:
16841
- $ref: '#/components/schemas/UsageAttributionTagNames'
16842
- updated_at:
16843
- description: Shows the the most recent hour in the current month for all
16844
- organizations for which all usages were calculated.
16845
- type: string
16846
- values:
16847
- $ref: '#/components/schemas/UsageAttributionValues'
16848
- type: object
16849
- UsageAttributionLimit:
16850
- default: 5000
16851
- description: Maximum number of records to be returned.
16852
- format: int64
16853
- type: integer
16854
- UsageAttributionMetadata:
16855
- description: The object containing document metadata.
16856
- properties:
16857
- aggregates:
16858
- $ref: '#/components/schemas/UsageAttributionAggregates'
16859
- pagination:
16860
- $ref: '#/components/schemas/UsageAttributionPagination'
16861
- type: object
16862
- UsageAttributionOffset:
16863
- default: 0
16864
- description: Number of records to skip before beginning to return.
16865
- format: int64
16866
- type: integer
16867
- UsageAttributionPagination:
16868
- description: The metadata for the current pagination.
16869
- properties:
16870
- limit:
16871
- description: Maximum amount of records to be returned.
16872
- format: int64
16873
- type: integer
16874
- offset:
16875
- description: Records to be skipped before beginning to return.
16876
- format: int64
16877
- type: integer
16878
- sort_direction:
16879
- description: Direction to sort by.
16880
- type: string
16881
- sort_name:
16882
- description: Field to sort by.
16883
- type: string
16884
- total_number_of_records:
16885
- description: Total number of records.
16886
- format: int64
16887
- type: integer
16888
- type: object
16889
- UsageAttributionResponse:
16890
- description: Response containing the Usage Summary by tag(s).
16891
- properties:
16892
- metadata:
16893
- $ref: '#/components/schemas/UsageAttributionMetadata'
16894
- usage:
16895
- description: Get usage summary by tag(s).
16896
- items:
16897
- $ref: '#/components/schemas/UsageAttributionBody'
16898
- type: array
16899
- type: object
16900
- UsageAttributionSort:
16901
- default: custom_timeseries_usage
16902
- description: The field to sort by.
16903
- enum:
16904
- - api_percentage
16905
- - snmp_usage
16906
- - apm_host_usage
16907
- - api_usage
16908
- - appsec_usage
16909
- - appsec_percentage
16910
- - container_usage
16911
- - custom_timeseries_percentage
16912
- - container_percentage
16913
- - apm_host_percentage
16914
- - npm_host_percentage
16915
- - browser_percentage
16916
- - browser_usage
16917
- - infra_host_percentage
16918
- - snmp_percentage
16919
- - npm_host_usage
16920
- - infra_host_usage
16921
- - custom_timeseries_usage
16922
- - lambda_functions_usage
16923
- - lambda_functions_percentage
16924
- - lambda_invocations_usage
16925
- - lambda_invocations_percentage
16926
- - estimated_indexed_logs_usage
16927
- - estimated_indexed_logs_percentage
16928
- - estimated_ingested_logs_usage
16929
- - estimated_ingested_logs_percentage
16930
- - estimated_indexed_spans_usage
16931
- - estimated_indexed_spans_percentage
16932
- - estimated_ingested_spans_usage
16933
- - estimated_ingested_spans_percentage
16934
- - apm_fargate_usage
16935
- - apm_fargate_percentage
16936
- - appsec_fargate_usage
16937
- - appsec_fargate_percentage
16938
- - estimated_rum_usage_attribution_usage
16939
- - estimated_rum_usage_attribution_percentage
16940
- - asm_serverless_traced_invocations_usage
16941
- - asm_serverless_traced_invocations_percentage
16942
- type: string
16943
- x-enum-varnames:
16944
- - API_PERCENTAGE
16945
- - SNMP_USAGE
16946
- - APM_HOST_USAGE
16947
- - API_USAGE
16948
- - APPSEC_USAGE
16949
- - APPSEC_PERCENTAGE
16950
- - CONTAINER_USAGE
16951
- - CUSTOM_TIMESERIES_PERCENTAGE
16952
- - CONTAINER_PERCENTAGE
16953
- - APM_HOST_PERCENTAGE
16954
- - NPM_HOST_PERCENTAGE
16955
- - BROWSER_PERCENTAGE
16956
- - BROWSER_USAGE
16957
- - INFRA_HOST_PERCENTAGE
16958
- - SNMP_PERCENTAGE
16959
- - NPM_HOST_USAGE
16960
- - INFRA_HOST_USAGE
16961
- - CUSTOM_TIMESERIES_USAGE
16962
- - LAMBDA_FUNCTIONS_USAGE
16963
- - LAMBDA_FUNCTIONS_PERCENTAGE
16964
- - LAMBDA_INVOCATIONS_USAGE
16965
- - LAMBDA_INVOCATIONS_PERCENTAGE
16966
- - ESTIMATED_INDEXED_LOGS_USAGE
16967
- - ESTIMATED_INDEXED_LOGS_PERCENTAGE
16968
- - ESTIMATED_INGESTED_LOGS_USAGE
16969
- - ESTIMATED_INGESTED_LOGS_PERCENTAGE
16970
- - ESTIMATED_INDEXED_SPANS_USAGE
16971
- - ESTIMATED_INDEXED_SPANS_PERCENTAGE
16972
- - ESTIMATED_INGESTED_SPANS_USAGE
16973
- - ESTIMATED_INGESTED_SPANS_PERCENTAGE
16974
- - APM_FARGATE_USAGE
16975
- - APM_FARGATE_PERCENTAGE
16976
- - APPSEC_FARGATE_USAGE
16977
- - APPSEC_FARGATE_PERCENTAGE
16978
- - ESTIMATED_RUM_USAGE_ATTRIBUTION_USAGE
16979
- - ESTIMATED_RUM_USAGE_ATTRIBUTION_PERCENTAGE
16980
- - ASM_SERVERLESS_TRACED_INVOCATIONS_USAGE
16981
- - ASM_SERVERLESS_TRACED_INVOCATIONS_PERCENTAGE
16982
- UsageAttributionSupportedMetrics:
16983
- description: Supported fields for usage attribution requests (valid requests
16984
- contain one or more metrics, or `*` for all).
16985
- enum:
16986
- - custom_timeseries_usage
16987
- - container_usage
16988
- - snmp_percentage
16989
- - apm_host_usage
16990
- - browser_usage
16991
- - npm_host_percentage
16992
- - infra_host_usage
16993
- - custom_timeseries_percentage
16994
- - container_percentage
16995
- - api_usage
16996
- - apm_host_percentage
16997
- - infra_host_percentage
16998
- - snmp_usage
16999
- - browser_percentage
17000
- - api_percentage
17001
- - npm_host_usage
17002
- - lambda_functions_usage
17003
- - lambda_functions_percentage
17004
- - lambda_invocations_usage
17005
- - lambda_invocations_percentage
17006
- - fargate_usage
17007
- - fargate_percentage
17008
- - profiled_host_usage
17009
- - profiled_host_percentage
17010
- - profiled_container_usage
17011
- - profiled_container_percentage
17012
- - dbm_hosts_usage
17013
- - dbm_hosts_percentage
17014
- - dbm_queries_usage
17015
- - dbm_queries_percentage
17016
- - estimated_indexed_logs_usage
17017
- - estimated_indexed_logs_percentage
17018
- - estimated_ingested_logs_usage
17019
- - estimated_ingested_logs_percentage
17020
- - appsec_usage
17021
- - appsec_percentage
17022
- - estimated_indexed_spans_usage
17023
- - estimated_indexed_spans_percentage
17024
- - estimated_ingested_spans_usage
17025
- - estimated_ingested_spans_percentage
17026
- - apm_fargate_usage
17027
- - apm_fargate_percentage
17028
- - appsec_fargate_usage
17029
- - appsec_fargate_percentage
17030
- - estimated_rum_usage_attribution_usage
17031
- - estimated_rum_usage_attribution_percentage
17032
- - asm_serverless_traced_invocations_usage
17033
- - asm_serverless_traced_invocations_percentage
17034
- - '*'
17035
- type: string
17036
- x-enum-varnames:
17037
- - CUSTOM_TIMESERIES_USAGE
17038
- - CONTAINER_USAGE
17039
- - SNMP_PERCENTAGE
17040
- - APM_HOST_USAGE
17041
- - BROWSER_USAGE
17042
- - NPM_HOST_PERCENTAGE
17043
- - INFRA_HOST_USAGE
17044
- - CUSTOM_TIMESERIES_PERCENTAGE
17045
- - CONTAINER_PERCENTAGE
17046
- - API_USAGE
17047
- - APM_HOST_PERCENTAGE
17048
- - INFRA_HOST_PERCENTAGE
17049
- - SNMP_USAGE
17050
- - BROWSER_PERCENTAGE
17051
- - API_PERCENTAGE
17052
- - NPM_HOST_USAGE
17053
- - LAMBDA_FUNCTIONS_USAGE
17054
- - LAMBDA_FUNCTIONS_PERCENTAGE
17055
- - LAMBDA_INVOCATIONS_USAGE
17056
- - LAMBDA_INVOCATIONS_PERCENTAGE
17057
- - FARGATE_USAGE
17058
- - FARGATE_PERCENTAGE
17059
- - PROFILED_HOST_USAGE
17060
- - PROFILED_HOST_PERCENTAGE
17061
- - PROFILED_CONTAINER_USAGE
17062
- - PROFILED_CONTAINER_PERCENTAGE
17063
- - DBM_HOSTS_USAGE
17064
- - DBM_HOSTS_PERCENTAGE
17065
- - DBM_QUERIES_USAGE
17066
- - DBM_QUERIES_PERCENTAGE
17067
- - ESTIMATED_INDEXED_LOGS_USAGE
17068
- - ESTIMATED_INDEXED_LOGS_PERCENTAGE
17069
- - ESTIMATED_INGESTED_LOGS_USAGE
17070
- - ESTIMATED_INGESTED_LOGS_PERCENTAGE
17071
- - APPSEC_USAGE
17072
- - APPSEC_PERCENTAGE
17073
- - ESTIMATED_INDEXED_SPANS_USAGE
17074
- - ESTIMATED_INDEXED_SPANS_PERCENTAGE
17075
- - ESTIMATED_INGESTED_SPANS_USAGE
17076
- - ESTIMATED_INGESTED_SPANS_PERCENTAGE
17077
- - APM_FARGATE_USAGE
17078
- - APM_FARGATE_PERCENTAGE
17079
- - APPSEC_FARGATE_USAGE
17080
- - APPSEC_FARGATE_PERCENTAGE
17081
- - ESTIMATED_RUM_USAGE_ATTRIBUTION_USAGE
17082
- - ESTIMATED_RUM_USAGE_ATTRIBUTION_PERCENTAGE
17083
- - ASM_SERVERLESS_TRACED_INVOCATIONS_USAGE
17084
- - ASM_SERVERLESS_TRACED_INVOCATIONS_PERCENTAGE
17085
- - ALL
17086
17010
  UsageAttributionTagNames:
17087
17011
  additionalProperties:
17088
17012
  description: 'A list of values that are associated with each tag key.
@@ -17112,225 +17036,6 @@ components:
17112
17036
  In this scenario the API returns the total usage, not broken down by tags.'
17113
17037
  nullable: true
17114
17038
  type: object
17115
- UsageAttributionValues:
17116
- description: Fields in Usage Summary by tag(s).
17117
- properties:
17118
- api_percentage:
17119
- description: The percentage of synthetic API test usage by tag(s).
17120
- format: double
17121
- type: number
17122
- api_usage:
17123
- description: The synthetic API test usage by tag(s).
17124
- format: double
17125
- type: number
17126
- apm_fargate_percentage:
17127
- description: The percentage of APM ECS Fargate task usage by tag(s).
17128
- format: double
17129
- type: number
17130
- apm_fargate_usage:
17131
- description: The APM ECS Fargate task usage by tag(s).
17132
- format: double
17133
- type: number
17134
- apm_host_percentage:
17135
- description: The percentage of APM host usage by tag(s).
17136
- format: double
17137
- type: number
17138
- apm_host_usage:
17139
- description: The APM host usage by tag(s).
17140
- format: double
17141
- type: number
17142
- appsec_fargate_percentage:
17143
- description: The percentage of Application Security Monitoring ECS Fargate
17144
- task usage by tag(s).
17145
- format: double
17146
- type: number
17147
- appsec_fargate_usage:
17148
- description: The Application Security Monitoring ECS Fargate task usage
17149
- by tag(s).
17150
- format: double
17151
- type: number
17152
- appsec_percentage:
17153
- description: The percentage of Application Security Monitoring host usage
17154
- by tag(s).
17155
- format: double
17156
- type: number
17157
- appsec_usage:
17158
- description: The Application Security Monitoring host usage by tag(s).
17159
- format: double
17160
- type: number
17161
- browser_percentage:
17162
- description: The percentage of synthetic browser test usage by tag(s).
17163
- format: double
17164
- type: number
17165
- browser_usage:
17166
- description: The synthetic browser test usage by tag(s).
17167
- format: double
17168
- type: number
17169
- container_percentage:
17170
- description: The percentage of container usage by tag(s).
17171
- format: double
17172
- type: number
17173
- container_usage:
17174
- description: The container usage by tag(s).
17175
- format: double
17176
- type: number
17177
- cspm_container_percentage:
17178
- description: The percentage of Cloud Security Management Pro container usage
17179
- by tag(s)
17180
- format: double
17181
- type: number
17182
- cspm_container_usage:
17183
- description: The Cloud Security Management Pro container usage by tag(s)
17184
- format: double
17185
- type: number
17186
- cspm_host_percentage:
17187
- description: The percentage of Cloud Security Management Pro host usage
17188
- by tag(s)
17189
- format: double
17190
- type: number
17191
- cspm_host_usage:
17192
- description: The Cloud Security Management Pro host usage by tag(s)
17193
- format: double
17194
- type: number
17195
- custom_timeseries_percentage:
17196
- description: The percentage of custom metrics usage by tag(s).
17197
- format: double
17198
- type: number
17199
- custom_timeseries_usage:
17200
- description: The custom metrics usage by tag(s).
17201
- format: double
17202
- type: number
17203
- cws_container_percentage:
17204
- description: The percentage of Cloud Workload Security container usage by
17205
- tag(s)
17206
- format: double
17207
- type: number
17208
- cws_container_usage:
17209
- description: The Cloud Workload Security container usage by tag(s)
17210
- format: double
17211
- type: number
17212
- cws_host_percentage:
17213
- description: The percentage of Cloud Workload Security host usage by tag(s)
17214
- format: double
17215
- type: number
17216
- cws_host_usage:
17217
- description: The Cloud Workload Security host usage by tag(s)
17218
- format: double
17219
- type: number
17220
- dbm_hosts_percentage:
17221
- description: The percentage of Database Monitoring host usage by tag(s).
17222
- format: double
17223
- type: number
17224
- dbm_hosts_usage:
17225
- description: The Database Monitoring host usage by tag(s).
17226
- format: double
17227
- type: number
17228
- dbm_queries_percentage:
17229
- description: The percentage of Database Monitoring normalized queries usage
17230
- by tag(s).
17231
- format: double
17232
- type: number
17233
- dbm_queries_usage:
17234
- description: The Database Monitoring normalized queries usage by tag(s).
17235
- format: double
17236
- type: number
17237
- estimated_indexed_logs_percentage:
17238
- description: The percentage of estimated live indexed logs usage by tag(s).
17239
- format: double
17240
- type: number
17241
- estimated_indexed_logs_usage:
17242
- description: The estimated live indexed logs usage by tag(s).
17243
- format: double
17244
- type: number
17245
- estimated_indexed_spans_percentage:
17246
- description: The percentage of estimated indexed spans usage by tag(s).
17247
- format: double
17248
- type: number
17249
- estimated_indexed_spans_usage:
17250
- description: The estimated indexed spans usage by tag(s).
17251
- format: double
17252
- type: number
17253
- estimated_ingested_logs_percentage:
17254
- description: The percentage of estimated live ingested logs usage by tag(s).
17255
- format: double
17256
- type: number
17257
- estimated_ingested_logs_usage:
17258
- description: The estimated live ingested logs usage by tag(s).
17259
- format: double
17260
- type: number
17261
- estimated_ingested_spans_percentage:
17262
- description: The percentage of estimated ingested spans usage by tag(s).
17263
- format: double
17264
- type: number
17265
- estimated_ingested_spans_usage:
17266
- description: The estimated ingested spans usage by tag(s).
17267
- format: double
17268
- type: number
17269
- estimated_rum_sessions_percentage:
17270
- description: The percentage of estimated rum sessions usage by tag(s).
17271
- format: double
17272
- type: number
17273
- estimated_rum_sessions_usage:
17274
- description: The estimated rum sessions usage by tag(s).
17275
- format: double
17276
- type: number
17277
- infra_host_percentage:
17278
- description: The percentage of infrastructure host usage by tag(s).
17279
- format: double
17280
- type: number
17281
- infra_host_usage:
17282
- description: The infrastructure host usage by tag(s).
17283
- format: double
17284
- type: number
17285
- lambda_functions_percentage:
17286
- description: The percentage of Lambda function usage by tag(s).
17287
- format: double
17288
- type: number
17289
- lambda_functions_usage:
17290
- description: The Lambda function usage by tag(s).
17291
- format: double
17292
- type: number
17293
- lambda_invocations_percentage:
17294
- description: The percentage of Lambda invocation usage by tag(s).
17295
- format: double
17296
- type: number
17297
- lambda_invocations_usage:
17298
- description: The Lambda invocation usage by tag(s).
17299
- format: double
17300
- type: number
17301
- npm_host_percentage:
17302
- description: The percentage of network host usage by tag(s).
17303
- format: double
17304
- type: number
17305
- npm_host_usage:
17306
- description: The network host usage by tag(s).
17307
- format: double
17308
- type: number
17309
- profiled_container_percentage:
17310
- description: The percentage of profiled containers usage by tag(s).
17311
- format: double
17312
- type: number
17313
- profiled_container_usage:
17314
- description: The profiled container usage by tag(s).
17315
- format: double
17316
- type: number
17317
- profiled_hosts_percentage:
17318
- description: The percentage of profiled hosts usage by tag(s).
17319
- format: double
17320
- type: number
17321
- profiled_hosts_usage:
17322
- description: The profiled host usage by tag(s).
17323
- format: double
17324
- type: number
17325
- snmp_percentage:
17326
- description: The percentage of network device usage by tag(s).
17327
- format: double
17328
- type: number
17329
- snmp_usage:
17330
- description: The network device usage by tag(s).
17331
- format: double
17332
- type: number
17333
- type: object
17334
17039
  UsageAuditLogsHour:
17335
17040
  description: Audit logs usage for a given organization for a given hour.
17336
17041
  properties:
@@ -17533,6 +17238,8 @@ components:
17533
17238
  $ref: '#/components/schemas/UsageBillableSummaryBody'
17534
17239
  logs_indexed_180day_sum:
17535
17240
  $ref: '#/components/schemas/UsageBillableSummaryBody'
17241
+ logs_indexed_1day_sum:
17242
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
17536
17243
  logs_indexed_30day_sum:
17537
17244
  $ref: '#/components/schemas/UsageBillableSummaryBody'
17538
17245
  logs_indexed_360day_sum:
@@ -21729,18 +21436,28 @@ components:
21729
21436
  authorizationCode:
21730
21437
  authorizationUrl: /oauth2/v1/authorize
21731
21438
  scopes:
21439
+ apm_read: Read and query APM and Trace Analytics.
21732
21440
  apm_service_catalog_read: View service catalog and service definitions.
21733
21441
  apm_service_catalog_write: Add, modify, and delete service catalog definitions
21734
21442
  when those definitions are maintained by Datadog.
21735
21443
  ci_visibility_pipelines_write: Create CI Visibility pipeline spans using
21736
21444
  the API.
21737
21445
  ci_visibility_read: View CI Visibility.
21446
+ cloud_cost_management_read: View Cloud Cost pages. This does not restrict
21447
+ access to the cloud cost data source in dashboards and notebooks.
21448
+ cloud_cost_management_write: Configure cloud cost accounts and global
21449
+ customizations.
21450
+ continuous_profiler_pgo_read: Read and query Continuous Profiler data
21451
+ for Profile-Guided Optimization (PGO).
21738
21452
  create_webhooks: Create webhooks integrations.
21739
21453
  dashboards_public_share: Generate public and authenticated links to share
21740
21454
  dashboards or embeddable graphs externally.
21741
21455
  dashboards_read: View dashboards.
21742
21456
  dashboards_write: Create and change dashboards.
21457
+ data_scanner_read: View Data Scanner configurations.
21458
+ data_scanner_write: Edit Data Scanner configurations.
21743
21459
  events_read: Read Events data.
21460
+ hosts_read: List hosts and their attributes.
21744
21461
  incident_notification_settings_write: Configure Incidents Notification
21745
21462
  settings.
21746
21463
  incident_read: View incidents in Datadog.
@@ -21748,10 +21465,15 @@ components:
21748
21465
  incident_write: Create, view, and manage incidents in Datadog.
21749
21466
  metrics_read: View custom metrics.
21750
21467
  monitors_downtime: Set downtimes to suppress alerts from any monitor in
21751
- an organization. Mute and unmute hosts. The ability to write monitors
21468
+ an organization. Mute and unmute monitors. The ability to write monitors
21752
21469
  is not required to set downtimes.
21753
21470
  monitors_read: View monitors.
21754
21471
  monitors_write: Edit and delete individual monitors.
21472
+ org_management: Edit org configurations, including authentication and
21473
+ certain security preferences such as configuring SAML, renaming an org,
21474
+ configuring allowed login methods, creating child orgs, subscribing
21475
+ & unsubscribing from apps in the marketplace, and enabling & disabling
21476
+ Remote Configuration for the entire organization.
21755
21477
  security_monitoring_filters_read: Read Security Filters.
21756
21478
  security_monitoring_filters_write: Create, edit, and delete Security Filters.
21757
21479
  security_monitoring_findings_read: View CSPM Findings.
@@ -22346,11 +22068,6 @@ paths:
22346
22068
  schema:
22347
22069
  $ref: '#/components/schemas/APIErrorResponse'
22348
22070
  description: Too many requests
22349
- security:
22350
- - apiKeyAuth: []
22351
- appKeyAuth: []
22352
- - AuthZ:
22353
- - usage_read
22354
22071
  summary: Get the list of available daily custom reports
22355
22072
  tags:
22356
22073
  - Usage Metering
@@ -22396,11 +22113,6 @@ paths:
22396
22113
  schema:
22397
22114
  $ref: '#/components/schemas/APIErrorResponse'
22398
22115
  description: Too many requests
22399
- security:
22400
- - apiKeyAuth: []
22401
- appKeyAuth: []
22402
- - AuthZ:
22403
- - usage_read
22404
22116
  summary: Get specified daily custom reports
22405
22117
  tags:
22406
22118
  - Usage Metering
@@ -24118,7 +23830,8 @@ paths:
24118
23830
  security:
24119
23831
  - apiKeyAuth: []
24120
23832
  appKeyAuth: []
24121
- - AuthZ: []
23833
+ - AuthZ:
23834
+ - hosts_read
24122
23835
  summary: Get all hosts for your organization
24123
23836
  tags:
24124
23837
  - Hosts
@@ -24163,7 +23876,8 @@ paths:
24163
23876
  security:
24164
23877
  - apiKeyAuth: []
24165
23878
  appKeyAuth: []
24166
- - AuthZ: []
23879
+ - AuthZ:
23880
+ - hosts_read
24167
23881
  summary: Get the total number of active hosts
24168
23882
  tags:
24169
23883
  - Hosts
@@ -24458,10 +24172,6 @@ paths:
24458
24172
  description: Authentication Error
24459
24173
  '429':
24460
24174
  $ref: '#/components/responses/TooManyRequestsResponse'
24461
- security:
24462
- - apiKeyAuth: []
24463
- appKeyAuth: []
24464
- - AuthZ: []
24465
24175
  summary: Get all Amazon EventBridge sources
24466
24176
  tags:
24467
24177
  - AWS Integration
@@ -26009,10 +25719,6 @@ paths:
26009
25719
  description: Forbidden
26010
25720
  '429':
26011
25721
  $ref: '#/components/responses/TooManyRequestsResponse'
26012
- security:
26013
- - apiKeyAuth: []
26014
- appKeyAuth: []
26015
- - AuthZ: []
26016
25722
  summary: Get indexes order
26017
25723
  tags:
26018
25724
  - Logs Indexes
@@ -26224,10 +25930,6 @@ paths:
26224
25930
  description: Forbidden
26225
25931
  '429':
26226
25932
  $ref: '#/components/responses/TooManyRequestsResponse'
26227
- security:
26228
- - apiKeyAuth: []
26229
- appKeyAuth: []
26230
- - AuthZ: []
26231
25933
  summary: Get pipeline order
26232
25934
  tags:
26233
25935
  - Logs Pipelines
@@ -26303,10 +26005,6 @@ paths:
26303
26005
  description: Forbidden
26304
26006
  '429':
26305
26007
  $ref: '#/components/responses/TooManyRequestsResponse'
26306
- security:
26307
- - apiKeyAuth: []
26308
- appKeyAuth: []
26309
- - AuthZ: []
26310
26008
  summary: Get all pipelines
26311
26009
  tags:
26312
26010
  - Logs Pipelines
@@ -26411,10 +26109,6 @@ paths:
26411
26109
  description: Forbidden
26412
26110
  '429':
26413
26111
  $ref: '#/components/responses/TooManyRequestsResponse'
26414
- security:
26415
- - apiKeyAuth: []
26416
- appKeyAuth: []
26417
- - AuthZ: []
26418
26112
  summary: Get a pipeline
26419
26113
  tags:
26420
26114
  - Logs Pipelines
@@ -27748,11 +27442,6 @@ paths:
27748
27442
  schema:
27749
27443
  $ref: '#/components/schemas/APIErrorResponse'
27750
27444
  description: Too many requests
27751
- security:
27752
- - apiKeyAuth: []
27753
- appKeyAuth: []
27754
- - AuthZ:
27755
- - usage_read
27756
27445
  summary: Get the list of available monthly custom reports
27757
27446
  tags:
27758
27447
  - Usage Metering
@@ -27804,11 +27493,6 @@ paths:
27804
27493
  schema:
27805
27494
  $ref: '#/components/schemas/APIErrorResponse'
27806
27495
  description: Too many requests
27807
- security:
27808
- - apiKeyAuth: []
27809
- appKeyAuth: []
27810
- - AuthZ:
27811
- - usage_read
27812
27496
  summary: Get specified monthly custom reports
27813
27497
  tags:
27814
27498
  - Usage Metering
@@ -31161,10 +30845,11 @@ paths:
31161
30845
  x-codegen-request-body-name: body
31162
30846
  /api/v1/usage/analyzed_logs:
31163
30847
  get:
30848
+ deprecated: true
31164
30849
  description: 'Get hourly usage for analyzed logs (Security Monitoring).
31165
30850
 
31166
- **Note:** hourly usage data for all products is now available in the [Get
31167
- hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
30851
+ **Note:** This endpoint has been deprecated. Hourly usage data for all products
30852
+ is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
31168
30853
  Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/)
31169
30854
  for the associated migration guide.'
31170
30855
  operationId: GetUsageAnalyzedLogs
@@ -31220,100 +30905,6 @@ paths:
31220
30905
  summary: Get hourly usage for analyzed logs
31221
30906
  tags:
31222
30907
  - Usage Metering
31223
- /api/v1/usage/attribution:
31224
- get:
31225
- deprecated: true
31226
- description: 'Get usage attribution.
31227
-
31228
- **Note:** This endpoint will be fully deprecated on December 1, 2022.
31229
-
31230
- Refer to [Migrating from v1 to v2 of the Usage Attribution API](https://docs.datadoghq.com/account_management/guide/usage-attribution-migration/)
31231
- for the associated migration guide.'
31232
- operationId: GetUsageAttribution
31233
- parameters:
31234
- - description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]`
31235
- for usage beginning in this month.
31236
-
31237
- Maximum of 15 months ago.'
31238
- in: query
31239
- name: start_month
31240
- required: true
31241
- schema:
31242
- format: date-time
31243
- type: string
31244
- - description: Comma-separated list of usage types to return, or `*` for all
31245
- usage types.
31246
- in: query
31247
- name: fields
31248
- required: true
31249
- schema:
31250
- $ref: '#/components/schemas/UsageAttributionSupportedMetrics'
31251
- - description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]`
31252
- for usage ending this month.'
31253
- in: query
31254
- name: end_month
31255
- required: false
31256
- schema:
31257
- format: date-time
31258
- type: string
31259
- - description: 'The direction to sort by: `[desc, asc]`.'
31260
- in: query
31261
- name: sort_direction
31262
- required: false
31263
- schema:
31264
- $ref: '#/components/schemas/UsageSortDirection'
31265
- - description: The field to sort by.
31266
- in: query
31267
- name: sort_name
31268
- required: false
31269
- schema:
31270
- $ref: '#/components/schemas/UsageAttributionSort'
31271
- - description: Include child org usage in the response. Defaults to false.
31272
- in: query
31273
- name: include_descendants
31274
- required: false
31275
- schema:
31276
- default: false
31277
- type: boolean
31278
- - description: Number of records to skip before beginning to return.
31279
- in: query
31280
- name: offset
31281
- required: false
31282
- schema:
31283
- $ref: '#/components/schemas/UsageAttributionOffset'
31284
- - description: Maximum number of records to be returned.
31285
- in: query
31286
- name: limit
31287
- required: false
31288
- schema:
31289
- $ref: '#/components/schemas/UsageAttributionLimit'
31290
- responses:
31291
- '200':
31292
- content:
31293
- application/json;datetime-format=rfc3339:
31294
- schema:
31295
- $ref: '#/components/schemas/UsageAttributionResponse'
31296
- description: OK
31297
- '403':
31298
- content:
31299
- application/json;datetime-format=rfc3339:
31300
- schema:
31301
- $ref: '#/components/schemas/APIErrorResponse'
31302
- description: Forbidden - User is not authorized
31303
- '429':
31304
- content:
31305
- application/json;datetime-format=rfc3339:
31306
- schema:
31307
- $ref: '#/components/schemas/APIErrorResponse'
31308
- description: Too many requests
31309
- security:
31310
- - apiKeyAuth: []
31311
- appKeyAuth: []
31312
- - AuthZ:
31313
- - usage_read
31314
- summary: Get usage attribution
31315
- tags:
31316
- - Usage Metering
31317
30908
  /api/v1/usage/audit_logs:
31318
30909
  get:
31319
30910
  deprecated: true
@@ -31375,10 +30966,11 @@ paths:
31375
30966
  - Usage Metering
31376
30967
  /api/v1/usage/aws_lambda:
31377
30968
  get:
30969
+ deprecated: true
31378
30970
  description: 'Get hourly usage for Lambda.
31379
30971
 
31380
- **Note:** hourly usage data for all products is now available in the [Get
31381
- hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
30972
+ **Note:** This endpoint has been deprecated. Hourly usage data for all products
30973
+ is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
31382
30974
  Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/)
31383
30975
  for the associated migration guide.'
31384
30976
  operationId: GetUsageLambda
@@ -31434,7 +31026,10 @@ paths:
31434
31026
  - Usage Metering
31435
31027
  /api/v1/usage/billable-summary:
31436
31028
  get:
31437
- description: Get billable usage across your account.
31029
+ description: 'Get billable usage across your account.
31030
+
31031
+
31032
+ This endpoint is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/).'
31438
31033
  operationId: GetUsageBillableSummary
31439
31034
  parameters:
31440
31035
  - description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]`
@@ -31480,10 +31075,11 @@ paths:
31480
31075
  - Usage Metering
31481
31076
  /api/v1/usage/ci-app:
31482
31077
  get:
31078
+ deprecated: true
31483
31079
  description: 'Get hourly usage for CI visibility (tests, pipeline, and spans).
31484
31080
 
31485
- **Note:** hourly usage data for all products is now available in the [Get
31486
- hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
31081
+ **Note:** This endpoint has been deprecated. Hourly usage data for all products
31082
+ is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
31487
31083
  Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/)
31488
31084
  for the associated migration guide.'
31489
31085
  operationId: GetUsageCIApp
@@ -31541,10 +31137,11 @@ paths:
31541
31137
  - Usage Metering
31542
31138
  /api/v1/usage/cspm:
31543
31139
  get:
31140
+ deprecated: true
31544
31141
  description: 'Get hourly usage for cloud security management (CSM) pro.
31545
31142
 
31546
- **Note:** hourly usage data for all products is now available in the [Get
31547
- hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
31143
+ **Note:** This endpoint has been deprecated. Hourly usage data for all products
31144
+ is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
31548
31145
  Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/)
31549
31146
  for the associated migration guide.'
31550
31147
  operationId: GetUsageCloudSecurityPostureManagement
@@ -31602,10 +31199,11 @@ paths:
31602
31199
  - Usage Metering
31603
31200
  /api/v1/usage/cws:
31604
31201
  get:
31202
+ deprecated: true
31605
31203
  description: 'Get hourly usage for cloud workload security.
31606
31204
 
31607
- **Note:** hourly usage data for all products is now available in the [Get
31608
- hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
31205
+ **Note:** This endpoint has been deprecated. Hourly usage data for all products
31206
+ is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
31609
31207
  Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/)
31610
31208
  for the associated migration guide.'
31611
31209
  operationId: GetUsageCWS
@@ -31663,10 +31261,11 @@ paths:
31663
31261
  - Usage Metering
31664
31262
  /api/v1/usage/dbm:
31665
31263
  get:
31264
+ deprecated: true
31666
31265
  description: 'Get hourly usage for database monitoring
31667
31266
 
31668
- **Note:** hourly usage data for all products is now available in the [Get
31669
- hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
31267
+ **Note:** This endpoint has been deprecated. Hourly usage data for all products
31268
+ is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
31670
31269
  Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/)
31671
31270
  for the associated migration guide.'
31672
31271
  operationId: GetUsageDBM
@@ -31724,10 +31323,11 @@ paths:
31724
31323
  - Usage Metering
31725
31324
  /api/v1/usage/fargate:
31726
31325
  get:
31326
+ deprecated: true
31727
31327
  description: 'Get hourly usage for [Fargate](https://docs.datadoghq.com/integrations/ecs_fargate/).
31728
31328
 
31729
- **Note:** hourly usage data for all products is now available in the [Get
31730
- hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
31329
+ **Note:** This endpoint has been deprecated. Hourly usage data for all products
31330
+ is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
31731
31331
  Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/)
31732
31332
  for the associated migration guide.'
31733
31333
  operationId: GetUsageFargate
@@ -31783,10 +31383,11 @@ paths:
31783
31383
  - Usage Metering
31784
31384
  /api/v1/usage/hosts:
31785
31385
  get:
31386
+ deprecated: true
31786
31387
  description: 'Get hourly usage for hosts and containers.
31787
31388
 
31788
- **Note:** hourly usage data for all products is now available in the [Get
31789
- hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
31389
+ **Note:** This endpoint has been deprecated. Hourly usage data for all products
31390
+ is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
31790
31391
  Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/)
31791
31392
  for the associated migration guide.'
31792
31393
  operationId: GetUsageHosts
@@ -31930,10 +31531,11 @@ paths:
31930
31531
  - Usage Metering
31931
31532
  /api/v1/usage/incident-management:
31932
31533
  get:
31534
+ deprecated: true
31933
31535
  description: 'Get hourly usage for incident management.
31934
31536
 
31935
- **Note:** hourly usage data for all products is now available in the [Get
31936
- hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
31537
+ **Note:** This endpoint has been deprecated. Hourly usage data for all products
31538
+ is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
31937
31539
  Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/)
31938
31540
  for the associated migration guide.'
31939
31541
  operationId: GetIncidentManagement
@@ -31991,10 +31593,11 @@ paths:
31991
31593
  - Usage Metering
31992
31594
  /api/v1/usage/indexed-spans:
31993
31595
  get:
31596
+ deprecated: true
31994
31597
  description: 'Get hourly usage for indexed spans.
31995
31598
 
31996
- **Note:** hourly usage data for all products is now available in the [Get
31997
- hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
31599
+ **Note:** This endpoint has been deprecated. Hourly usage data for all products
31600
+ is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
31998
31601
  Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/)
31999
31602
  for the associated migration guide.'
32000
31603
  operationId: GetUsageIndexedSpans
@@ -32050,10 +31653,11 @@ paths:
32050
31653
  - Usage Metering
32051
31654
  /api/v1/usage/ingested-spans:
32052
31655
  get:
31656
+ deprecated: true
32053
31657
  description: 'Get hourly usage for ingested spans.
32054
31658
 
32055
- **Note:** hourly usage data for all products is now available in the [Get
32056
- hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
31659
+ **Note:** This endpoint has been deprecated. Hourly usage data for all products
31660
+ is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
32057
31661
  Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/)
32058
31662
  for the associated migration guide.'
32059
31663
  operationId: GetIngestedSpans
@@ -32111,10 +31715,11 @@ paths:
32111
31715
  - Usage Metering
32112
31716
  /api/v1/usage/iot:
32113
31717
  get:
31718
+ deprecated: true
32114
31719
  description: 'Get hourly usage for IoT.
32115
31720
 
32116
- **Note:** hourly usage data for all products is now available in the [Get
32117
- hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
31721
+ **Note:** This endpoint has been deprecated. Hourly usage data for all products
31722
+ is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
32118
31723
  Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/)
32119
31724
  for the associated migration guide.'
32120
31725
  operationId: GetUsageInternetOfThings
@@ -32172,10 +31777,11 @@ paths:
32172
31777
  - Usage Metering
32173
31778
  /api/v1/usage/logs:
32174
31779
  get:
31780
+ deprecated: true
32175
31781
  description: 'Get hourly usage for logs.
32176
31782
 
32177
- **Note:** hourly usage data for all products is now available in the [Get
32178
- hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
31783
+ **Note:** This endpoint has been deprecated. Hourly usage data for all products
31784
+ is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
32179
31785
  Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/)
32180
31786
  for the associated migration guide.'
32181
31787
  operationId: GetUsageLogs
@@ -32231,10 +31837,11 @@ paths:
32231
31837
  - Usage Metering
32232
31838
  /api/v1/usage/logs-by-retention:
32233
31839
  get:
31840
+ deprecated: true
32234
31841
  description: 'Get hourly usage for indexed logs by retention period.
32235
31842
 
32236
- **Note:** hourly usage data for all products is now available in the [Get
32237
- hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
31843
+ **Note:** This endpoint has been deprecated. Hourly usage data for all products
31844
+ is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
32238
31845
  Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/)
32239
31846
  for the associated migration guide.'
32240
31847
  operationId: GetUsageLogsByRetention
@@ -32455,10 +32062,11 @@ paths:
32455
32062
  - Usage Metering
32456
32063
  /api/v1/usage/network_flows:
32457
32064
  get:
32065
+ deprecated: true
32458
32066
  description: 'Get hourly usage for network flows.
32459
32067
 
32460
- **Note:** hourly usage data for all products is now available in the [Get
32461
- hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
32068
+ **Note:** This endpoint has been deprecated. Hourly usage data for all products
32069
+ is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
32462
32070
  Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/)
32463
32071
  for the associated migration guide.'
32464
32072
  operationId: GetUsageNetworkFlows
@@ -32516,10 +32124,11 @@ paths:
32516
32124
  - Usage Metering
32517
32125
  /api/v1/usage/network_hosts:
32518
32126
  get:
32127
+ deprecated: true
32519
32128
  description: 'Get hourly usage for network hosts.
32520
32129
 
32521
- **Note:** hourly usage data for all products is now available in the [Get
32522
- hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
32130
+ **Note:** This endpoint has been deprecated. Hourly usage data for all products
32131
+ is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
32523
32132
  Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/)
32524
32133
  for the associated migration guide.'
32525
32134
  operationId: GetUsageNetworkHosts
@@ -32575,10 +32184,11 @@ paths:
32575
32184
  - Usage Metering
32576
32185
  /api/v1/usage/online-archive:
32577
32186
  get:
32187
+ deprecated: true
32578
32188
  description: 'Get hourly usage for online archive.
32579
32189
 
32580
- **Note:** hourly usage data for all products is now available in the [Get
32581
- hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
32190
+ **Note:** This endpoint has been deprecated. Hourly usage data for all products
32191
+ is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
32582
32192
  Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/)
32583
32193
  for the associated migration guide.'
32584
32194
  operationId: GetUsageOnlineArchive
@@ -32636,10 +32246,11 @@ paths:
32636
32246
  - Usage Metering
32637
32247
  /api/v1/usage/profiling:
32638
32248
  get:
32249
+ deprecated: true
32639
32250
  description: 'Get hourly usage for profiled hosts.
32640
32251
 
32641
- **Note:** hourly usage data for all products is now available in the [Get
32642
- hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
32252
+ **Note:** This endpoint has been deprecated. Hourly usage data for all products
32253
+ is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
32643
32254
  Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/)
32644
32255
  for the associated migration guide.'
32645
32256
  operationId: GetUsageProfiling
@@ -32697,11 +32308,12 @@ paths:
32697
32308
  - Usage Metering
32698
32309
  /api/v1/usage/rum:
32699
32310
  get:
32311
+ deprecated: true
32700
32312
  description: 'Get hourly usage for [RUM](https://docs.datadoghq.com/real_user_monitoring/)
32701
32313
  Units.
32702
32314
 
32703
- **Note:** hourly usage data for all products is now available in the [Get
32704
- hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
32315
+ **Note:** This endpoint has been deprecated. Hourly usage data for all products
32316
+ is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
32705
32317
  Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/)
32706
32318
  for the associated migration guide.'
32707
32319
  operationId: GetUsageRumUnits
@@ -32757,11 +32369,12 @@ paths:
32757
32369
  - Usage Metering
32758
32370
  /api/v1/usage/rum_sessions:
32759
32371
  get:
32372
+ deprecated: true
32760
32373
  description: 'Get hourly usage for [RUM](https://docs.datadoghq.com/real_user_monitoring/)
32761
32374
  Sessions.
32762
32375
 
32763
- **Note:** hourly usage data for all products is now available in the [Get
32764
- hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
32376
+ **Note:** This endpoint has been deprecated. Hourly usage data for all products
32377
+ is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
32765
32378
  Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/)
32766
32379
  for the associated migration guide.'
32767
32380
  operationId: GetUsageRumSessions
@@ -32823,10 +32436,11 @@ paths:
32823
32436
  - Usage Metering
32824
32437
  /api/v1/usage/sds:
32825
32438
  get:
32439
+ deprecated: true
32826
32440
  description: 'Get hourly usage for sensitive data scanner.
32827
32441
 
32828
- **Note:** hourly usage data for all products is now available in the [Get
32829
- hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
32442
+ **Note:** This endpoint has been deprecated. Hourly usage data for all products
32443
+ is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
32830
32444
  Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/)
32831
32445
  for the associated migration guide.'
32832
32446
  operationId: GetUsageSDS
@@ -32884,10 +32498,11 @@ paths:
32884
32498
  - Usage Metering
32885
32499
  /api/v1/usage/snmp:
32886
32500
  get:
32501
+ deprecated: true
32887
32502
  description: 'Get hourly usage for SNMP devices.
32888
32503
 
32889
- **Note:** hourly usage data for all products is now available in the [Get
32890
- hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
32504
+ **Note:** This endpoint has been deprecated. Hourly usage data for all products
32505
+ is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
32891
32506
  Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/)
32892
32507
  for the associated migration guide.'
32893
32508
  operationId: GetUsageSNMP
@@ -32945,7 +32560,10 @@ paths:
32945
32560
  - Usage Metering
32946
32561
  /api/v1/usage/summary:
32947
32562
  get:
32948
- description: Get all usage across your account.
32563
+ description: 'Get all usage across your account.
32564
+
32565
+
32566
+ This endpoint is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/).'
32949
32567
  operationId: GetUsageSummary
32950
32568
  parameters:
32951
32569
  - description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]`
@@ -33010,8 +32628,8 @@ paths:
33010
32628
  deprecated: true
33011
32629
  description: 'Get hourly usage for [synthetics checks](https://docs.datadoghq.com/synthetics/).
33012
32630
 
33013
- **Note:** hourly usage data for all products is now available in the [Get
33014
- hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
32631
+ **Note:** This endpoint has been deprecated. Hourly usage data for all products
32632
+ is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
33015
32633
  Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/)
33016
32634
  for the associated migration guide.'
33017
32635
  operationId: GetUsageSynthetics
@@ -33067,10 +32685,11 @@ paths:
33067
32685
  - Usage Metering
33068
32686
  /api/v1/usage/synthetics_api:
33069
32687
  get:
32688
+ deprecated: true
33070
32689
  description: 'Get hourly usage for [synthetics API checks](https://docs.datadoghq.com/synthetics/).
33071
32690
 
33072
- **Note:** hourly usage data for all products is now available in the [Get
33073
- hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
32691
+ **Note:** This endpoint has been deprecated. Hourly usage data for all products
32692
+ is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
33074
32693
  Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/)
33075
32694
  for the associated migration guide.'
33076
32695
  operationId: GetUsageSyntheticsAPI
@@ -33126,10 +32745,11 @@ paths:
33126
32745
  - Usage Metering
33127
32746
  /api/v1/usage/synthetics_browser:
33128
32747
  get:
32748
+ deprecated: true
33129
32749
  description: 'Get hourly usage for synthetics browser checks.
33130
32750
 
33131
- **Note:** hourly usage data for all products is now available in the [Get
33132
- hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
32751
+ **Note:** This endpoint has been deprecated. Hourly usage data for all products
32752
+ is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
33133
32753
  Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/)
33134
32754
  for the associated migration guide.'
33135
32755
  operationId: GetUsageSyntheticsBrowser
@@ -33185,10 +32805,11 @@ paths:
33185
32805
  - Usage Metering
33186
32806
  /api/v1/usage/timeseries:
33187
32807
  get:
32808
+ deprecated: true
33188
32809
  description: 'Get hourly usage for [custom metrics](https://docs.datadoghq.com/developers/metrics/custom_metrics/).
33189
32810
 
33190
- **Note:** hourly usage data for all products is now available in the [Get
33191
- hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
32811
+ **Note:** This endpoint has been deprecated. Hourly usage data for all products
32812
+ is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
33192
32813
  Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/)
33193
32814
  for the associated migration guide.'
33194
32815
  operationId: GetUsageTimeseries
@@ -33394,11 +33015,6 @@ paths:
33394
33015
  description: Conflict
33395
33016
  '429':
33396
33017
  $ref: '#/components/responses/TooManyRequestsResponse'
33397
- security:
33398
- - apiKeyAuth: []
33399
- appKeyAuth: []
33400
- - AuthZ:
33401
- - user_access_invite
33402
33018
  summary: Create a user
33403
33019
  tags:
33404
33020
  - Users
@@ -33562,7 +33178,6 @@ paths:
33562
33178
  $ref: '#/components/responses/TooManyRequestsResponse'
33563
33179
  security:
33564
33180
  - apiKeyAuth: []
33565
- - AuthZ: []
33566
33181
  summary: Validate API key
33567
33182
  tags:
33568
33183
  - Authentication
@@ -34021,8 +33636,6 @@ tags:
34021
33636
 
34022
33637
  This API is available to all Pro and Enterprise customers.
34023
33638
 
34024
- Usage is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/).
34025
-
34026
33639
 
34027
33640
  **Note**: Usage data is delayed by up to 72 hours from when it was incurred.
34028
33641