datadog_api_client 1.0.0 → 1.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (190) hide show
  1. checksums.yaml +4 -4
  2. data/.apigentools-info +6 -6
  3. data/.github/workflows/scripts/test_integration.js +24 -0
  4. data/.github/workflows/test.yml +4 -0
  5. data/.github/workflows/test_integration.yml +87 -0
  6. data/.openapi-generator/FILES +48 -0
  7. data/CHANGELOG.md +18 -0
  8. data/README.md +1 -1
  9. data/data/v1/openapi.yaml +1133 -99
  10. data/data/v2/openapi.yaml +420 -13
  11. data/docs/v1/Downtime.md +2 -0
  12. data/docs/v1/DowntimeChild.md +48 -0
  13. data/docs/v1/MetricsAPI.md +1 -1
  14. data/docs/v1/Monitor.md +3 -3
  15. data/docs/v1/MonitorGroupSearchResponse.md +22 -0
  16. data/docs/v1/MonitorGroupSearchResponseCounts.md +20 -0
  17. data/docs/v1/MonitorGroupSearchResult.md +30 -0
  18. data/docs/v1/MonitorOptions.md +1 -1
  19. data/docs/v1/MonitorSearchResponse.md +22 -0
  20. data/docs/v1/MonitorSearchResponseCounts.md +24 -0
  21. data/docs/v1/MonitorSearchResponseMetadata.md +24 -0
  22. data/docs/v1/MonitorSearchResult.md +40 -0
  23. data/docs/v1/MonitorSearchResultNotification.md +20 -0
  24. data/docs/v1/MonitorsAPI.md +155 -13
  25. data/docs/v1/NotebookCreateDataAttributes.md +1 -1
  26. data/docs/v1/NotebookResponseDataAttributes.md +3 -3
  27. data/docs/v1/NotebookUpdateDataAttributes.md +1 -1
  28. data/docs/v1/NotebooksResponse.md +1 -1
  29. data/docs/v1/NotebooksResponseData.md +22 -0
  30. data/docs/v1/NotebooksResponseDataAttributes.md +30 -0
  31. data/docs/v1/README.md +25 -4
  32. data/docs/v1/SyntheticsAPI.md +62 -2
  33. data/docs/v1/SyntheticsAPITest.md +2 -2
  34. data/docs/v1/SyntheticsAPITestConfig.md +1 -1
  35. data/docs/v1/SyntheticsBrowserTest.md +2 -2
  36. data/docs/v1/SyntheticsConfigVariable.md +3 -1
  37. data/docs/v1/SyntheticsGlobalVariableValue.md +1 -1
  38. data/docs/v1/SyntheticsListGlobalVariablesResponse.md +18 -0
  39. data/docs/v1/SyntheticsTestConfig.md +1 -1
  40. data/docs/v1/SyntheticsTestDetails.md +2 -2
  41. data/docs/v1/UsageAttributionBody.md +2 -0
  42. data/docs/v1/UsageAttributionPagination.md +3 -7
  43. data/docs/v1/UsageAttributionValues.md +8 -0
  44. data/docs/v1/UsageAuditLogsHour.md +20 -0
  45. data/docs/v1/UsageAuditLogsResponse.md +18 -0
  46. data/docs/v1/UsageCWSHour.md +22 -0
  47. data/docs/v1/UsageCWSResponse.md +18 -0
  48. data/docs/v1/UsageCloudSecurityPostureManagementHour.md +22 -0
  49. data/docs/v1/UsageCloudSecurityPostureManagementResponse.md +18 -0
  50. data/docs/v1/UsageMeteringAPI.md +157 -21
  51. data/docs/v1/UsageSummaryDate.md +12 -4
  52. data/docs/v1/UsageSummaryDateOrg.md +12 -4
  53. data/docs/v1/UsageSummaryResponse.md +12 -4
  54. data/docs/v1/UsageTopAvgMetricsMetadata.md +2 -2
  55. data/docs/v1/WidgetCustomLink.md +7 -3
  56. data/docs/v2/IncidentServicesAPI.md +2 -2
  57. data/docs/v2/IncidentTeamsAPI.md +2 -2
  58. data/docs/v2/IncidentsAPI.md +2 -2
  59. data/docs/v2/IncidentsResponse.md +1 -1
  60. data/docs/v2/KeyManagementAPI.md +6 -6
  61. data/docs/v2/README.md +21 -0
  62. data/docs/v2/RelationshipToIncidentIntegrationMetadataData.md +1 -1
  63. data/docs/v2/RelationshipToIncidentIntegrationMetadatas.md +1 -1
  64. data/docs/v2/RolesAPI.md +4 -4
  65. data/docs/v2/SecurityFilter.md +22 -0
  66. data/docs/v2/SecurityFilterAttributes.md +30 -0
  67. data/docs/v2/SecurityFilterCreateAttributes.md +26 -0
  68. data/docs/v2/SecurityFilterCreateData.md +20 -0
  69. data/docs/v2/SecurityFilterCreateRequest.md +18 -0
  70. data/docs/v2/SecurityFilterDeleteResponse.md +18 -0
  71. data/docs/v2/SecurityFilterExclusionFilter.md +20 -0
  72. data/docs/v2/SecurityFilterExclusionFilterResponse.md +20 -0
  73. data/docs/v2/SecurityFilterFilteredDataType.md +15 -0
  74. data/docs/v2/SecurityFilterMeta.md +18 -0
  75. data/docs/v2/SecurityFilterResponse.md +20 -0
  76. data/docs/v2/SecurityFilterType.md +15 -0
  77. data/docs/v2/SecurityFilterUpdateAttributes.md +28 -0
  78. data/docs/v2/SecurityFilterUpdateData.md +20 -0
  79. data/docs/v2/SecurityFilterUpdateRequest.md +18 -0
  80. data/docs/v2/SecurityFiltersResponse.md +20 -0
  81. data/docs/v2/SecurityMonitoringAPI.md +316 -2
  82. data/docs/v2/UsersAPI.md +10 -10
  83. data/lib/datadog_api_client/v1.rb +18 -2
  84. data/lib/datadog_api_client/v1/api/metrics_api.rb +2 -2
  85. data/lib/datadog_api_client/v1/api/monitors_api.rb +163 -5
  86. data/lib/datadog_api_client/v1/api/synthetics_api.rb +67 -0
  87. data/lib/datadog_api_client/v1/api/usage_metering_api.rb +180 -23
  88. data/lib/datadog_api_client/v1/models/downtime.rb +11 -1
  89. data/lib/datadog_api_client/v1/models/downtime_child.rb +427 -0
  90. data/lib/datadog_api_client/v1/models/monitor.rb +10 -0
  91. data/lib/datadog_api_client/v1/models/monitor_group_search_response.rb +243 -0
  92. data/lib/datadog_api_client/v1/models/monitor_group_search_response_counts.rb +237 -0
  93. data/lib/datadog_api_client/v1/models/monitor_group_search_result.rb +285 -0
  94. data/lib/datadog_api_client/v1/models/monitor_options.rb +1 -1
  95. data/lib/datadog_api_client/v1/models/monitor_search_response.rb +243 -0
  96. data/lib/datadog_api_client/v1/models/monitor_search_response_counts.rb +261 -0
  97. data/lib/datadog_api_client/v1/models/monitor_search_response_metadata.rb +253 -0
  98. data/lib/datadog_api_client/v1/models/monitor_search_result.rb +339 -0
  99. data/lib/datadog_api_client/v1/models/monitor_search_result_notification.rb +233 -0
  100. data/lib/datadog_api_client/v1/models/notebook_create_data_attributes.rb +1 -1
  101. data/lib/datadog_api_client/v1/models/notebook_distribution_cell_attributes.rb +1 -1
  102. data/lib/datadog_api_client/v1/models/notebook_heat_map_cell_attributes.rb +1 -1
  103. data/lib/datadog_api_client/v1/models/notebook_log_stream_cell_attributes.rb +1 -1
  104. data/lib/datadog_api_client/v1/models/notebook_markdown_cell_attributes.rb +1 -1
  105. data/lib/datadog_api_client/v1/models/notebook_response_data_attributes.rb +3 -3
  106. data/lib/datadog_api_client/v1/models/notebook_timeseries_cell_attributes.rb +1 -1
  107. data/lib/datadog_api_client/v1/models/notebook_toplist_cell_attributes.rb +1 -1
  108. data/lib/datadog_api_client/v1/models/notebook_update_data_attributes.rb +1 -1
  109. data/lib/datadog_api_client/v1/models/notebooks_response.rb +1 -1
  110. data/lib/datadog_api_client/v1/models/notebooks_response_data.rb +258 -0
  111. data/lib/datadog_api_client/v1/models/notebooks_response_data_attributes.rb +317 -0
  112. data/lib/datadog_api_client/v1/models/synthetics_api_test_config.rb +0 -5
  113. data/lib/datadog_api_client/v1/models/synthetics_config_variable.rb +11 -6
  114. data/lib/datadog_api_client/v1/models/synthetics_config_variable_type.rb +1 -0
  115. data/lib/datadog_api_client/v1/models/synthetics_global_variable_value.rb +0 -5
  116. data/lib/datadog_api_client/v1/models/synthetics_list_global_variables_response.rb +225 -0
  117. data/lib/datadog_api_client/v1/models/synthetics_test_config.rb +0 -5
  118. data/lib/datadog_api_client/v1/models/usage_attribution_body.rb +11 -1
  119. data/lib/datadog_api_client/v1/models/usage_attribution_pagination.rb +10 -30
  120. data/lib/datadog_api_client/v1/models/usage_attribution_values.rb +41 -1
  121. data/lib/datadog_api_client/v1/models/usage_audit_logs_hour.rb +233 -0
  122. data/lib/datadog_api_client/v1/models/{usage_compliance_response.rb → usage_audit_logs_response.rb} +6 -6
  123. data/lib/datadog_api_client/v1/models/{usage_compliance_hour.rb → usage_cloud_security_posture_management_hour.rb} +19 -19
  124. data/lib/datadog_api_client/v1/models/usage_cloud_security_posture_management_response.rb +225 -0
  125. data/lib/datadog_api_client/v1/models/usage_cws_hour.rb +243 -0
  126. data/lib/datadog_api_client/v1/models/usage_cws_response.rb +225 -0
  127. data/lib/datadog_api_client/v1/models/usage_summary_date.rb +61 -22
  128. data/lib/datadog_api_client/v1/models/usage_summary_date_org.rb +61 -22
  129. data/lib/datadog_api_client/v1/models/usage_summary_response.rb +61 -22
  130. data/lib/datadog_api_client/v1/models/usage_top_avg_metrics_metadata.rb +2 -4
  131. data/lib/datadog_api_client/v1/models/widget_custom_link.rb +24 -14
  132. data/lib/datadog_api_client/v2.rb +16 -0
  133. data/lib/datadog_api_client/v2/api/security_monitoring_api.rb +369 -0
  134. data/lib/datadog_api_client/v2/models/incident_integration_metadata_type.rb +1 -1
  135. data/lib/datadog_api_client/v2/models/relationship_to_incident_integration_metadata_data.rb +1 -1
  136. data/lib/datadog_api_client/v2/models/security_filter.rb +243 -0
  137. data/lib/datadog_api_client/v2/models/security_filter_attributes.rb +299 -0
  138. data/lib/datadog_api_client/v2/models/security_filter_create_attributes.rb +289 -0
  139. data/lib/datadog_api_client/v2/models/security_filter_create_data.rb +243 -0
  140. data/lib/datadog_api_client/v2/models/security_filter_create_request.rb +227 -0
  141. data/lib/datadog_api_client/v2/models/security_filter_delete_response.rb +222 -0
  142. data/lib/datadog_api_client/v2/models/security_filter_exclusion_filter.rb +243 -0
  143. data/lib/datadog_api_client/v2/models/security_filter_exclusion_filter_response.rb +233 -0
  144. data/lib/datadog_api_client/v2/models/security_filter_filtered_data_type.rb +39 -0
  145. data/lib/datadog_api_client/v2/models/security_filter_meta.rb +223 -0
  146. data/lib/datadog_api_client/v2/models/security_filter_response.rb +231 -0
  147. data/lib/datadog_api_client/v2/models/security_filter_type.rb +39 -0
  148. data/lib/datadog_api_client/v2/models/security_filter_update_attributes.rb +289 -0
  149. data/lib/datadog_api_client/v2/models/security_filter_update_data.rb +243 -0
  150. data/lib/datadog_api_client/v2/models/security_filter_update_request.rb +227 -0
  151. data/lib/datadog_api_client/v2/models/security_filters_response.rb +234 -0
  152. data/lib/datadog_api_client/version.rb +1 -1
  153. data/spec/v1/models/downtime_child_spec.rb +127 -0
  154. data/spec/v1/models/monitor_group_search_response_counts_spec.rb +43 -0
  155. data/spec/v1/models/monitor_group_search_response_spec.rb +49 -0
  156. data/spec/v1/models/monitor_group_search_result_spec.rb +73 -0
  157. data/spec/v1/models/monitor_search_response_counts_spec.rb +55 -0
  158. data/spec/v1/models/monitor_search_response_metadata_spec.rb +55 -0
  159. data/spec/v1/models/monitor_search_response_spec.rb +49 -0
  160. data/spec/v1/models/monitor_search_result_notification_spec.rb +43 -0
  161. data/spec/v1/models/monitor_search_result_spec.rb +103 -0
  162. data/spec/v1/models/notebooks_response_data_attributes_spec.rb +73 -0
  163. data/spec/v1/models/notebooks_response_data_spec.rb +49 -0
  164. data/spec/v1/models/synthetics_list_global_variables_response_spec.rb +37 -0
  165. data/spec/v1/models/usage_audit_logs_hour_spec.rb +43 -0
  166. data/spec/v1/models/{usage_compliance_response_spec.rb → usage_audit_logs_response_spec.rb} +6 -6
  167. data/spec/v1/models/usage_cloud_security_posture_management_hour_spec.rb +49 -0
  168. data/spec/v1/models/usage_cloud_security_posture_management_response_spec.rb +37 -0
  169. data/spec/v1/models/{usage_compliance_hour_spec.rb → usage_cws_hour_spec.rb} +8 -8
  170. data/spec/v1/models/usage_cws_response_spec.rb +37 -0
  171. data/spec/v2/models/security_filter_attributes_spec.rb +73 -0
  172. data/spec/v2/models/security_filter_create_attributes_spec.rb +61 -0
  173. data/spec/v2/models/security_filter_create_data_spec.rb +43 -0
  174. data/spec/v2/models/security_filter_create_request_spec.rb +37 -0
  175. data/spec/v2/models/security_filter_delete_response_spec.rb +37 -0
  176. data/spec/v2/models/security_filter_exclusion_filter_response_spec.rb +43 -0
  177. data/spec/v2/models/security_filter_exclusion_filter_spec.rb +43 -0
  178. data/spec/v2/models/security_filter_filtered_data_type_spec.rb +31 -0
  179. data/spec/v2/models/security_filter_meta_spec.rb +37 -0
  180. data/spec/v2/models/security_filter_response_spec.rb +43 -0
  181. data/spec/v2/models/security_filter_spec.rb +49 -0
  182. data/spec/v2/models/security_filter_type_spec.rb +31 -0
  183. data/spec/v2/models/security_filter_update_attributes_spec.rb +67 -0
  184. data/spec/v2/models/security_filter_update_data_spec.rb +43 -0
  185. data/spec/v2/models/security_filter_update_request_spec.rb +37 -0
  186. data/spec/v2/models/security_filters_response_spec.rb +43 -0
  187. metadata +140 -11
  188. data/.azure-pipelines/all.yml +0 -50
  189. data/docs/v1/UsageComplianceHour.md +0 -22
  190. data/docs/v1/UsageComplianceResponse.md +0 -18
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6f8c27f68745fac84ba1e99c2eb2a3b8c5069c9f9eebb75e1613f17c46b881e7
4
- data.tar.gz: f76092cc4feefa6da4c37a5fe6518d7f2e43d0f80a3acbf0498f2a2605150052
3
+ metadata.gz: 966d9a971a8b59a89c3146c840524dfa0681c78a89c79010cc6c49ac432c051e
4
+ data.tar.gz: c080a88ce308169979c2341d257ae48bcba252ca6c1d6d6f057e0c24d902d0ab
5
5
  SHA512:
6
- metadata.gz: 5d8522e5a486a3fec4475bed5df0d9fd60a5140d36c8bde7e08680b8948de228504ee9bb85ee753b5629b991ec296dc6cbff0cbff505f3cc7480d6146bee9f77
7
- data.tar.gz: d391296273c9822018604c15266617d55ced689c4fe863f1b16eff624c76b48f4dc77c788d2e5c137b4e205a5a4f32a13166fad57da4c1c267105c5b4db3c15e
6
+ metadata.gz: 917343d9d3726e7d10ee74e9927130e1b3180aba3f2c2221e8da966a80ec765dbf397a482381e5dca8963230777fc612013d4ee2159b272d001602e65511f0fc
7
+ data.tar.gz: c4fb4d110cc1481ad2324a096cedb1eb7e0668a7da0641efaf3a69449416ea883d4fa74c0043c61fa96398f8229c3b40100762caa961b892a416cae0fb9f036b
data/.apigentools-info CHANGED
@@ -3,14 +3,14 @@
3
3
  "info_version": "2",
4
4
  "spec_versions": {
5
5
  "v1": {
6
- "apigentools_version": "1.4.1.dev6",
7
- "regenerated": "2021-05-12 09:43:20.279249",
8
- "spec_repo_commit": "62c8ffe"
6
+ "apigentools_version": "1.4.1.dev8",
7
+ "regenerated": "2021-06-07 11:36:45.335016",
8
+ "spec_repo_commit": "cb48df5"
9
9
  },
10
10
  "v2": {
11
- "apigentools_version": "1.4.1.dev6",
12
- "regenerated": "2021-05-12 09:44:17.148819",
13
- "spec_repo_commit": "62c8ffe"
11
+ "apigentools_version": "1.4.1.dev8",
12
+ "regenerated": "2021-06-07 11:37:41.263441",
13
+ "spec_repo_commit": "cb48df5"
14
14
  }
15
15
  }
16
16
  }
@@ -0,0 +1,24 @@
1
+ const SPEC_REPO = "datadog-api-spec"
2
+
3
+ module.exports.post_status_check = async (github, context, status) => {
4
+ const pr_num = context.payload.pull_request.head.ref.split("/")[2]
5
+ const {data: pr} = await github.pulls.get({
6
+ owner: context.repo.owner,
7
+ repo: SPEC_REPO,
8
+ pull_number: pr_num,
9
+ });
10
+ const { data: jobs } = await github.actions.listJobsForWorkflowRun({
11
+ owner: context.repo.owner,
12
+ repo: context.repo.repo,
13
+ run_id: context.runId
14
+ });
15
+ await github.repos.createCommitStatus({
16
+ owner: context.repo.owner,
17
+ repo: SPEC_REPO,
18
+ sha: pr.head.sha,
19
+ state: status,
20
+ target_url: `https://github.com/${context.repo.owner}/${context.repo.repo}/pull/${context.payload.pull_request.number}/checks?check_run_id=${jobs.jobs[0].id}`,
21
+ description: `${context.repo.repo} integration tests`,
22
+ context: `${context.repo.repo}_integration_tests`
23
+ });
24
+ }
@@ -5,6 +5,10 @@ on:
5
5
  branches:
6
6
  - master
7
7
 
8
+ concurrency:
9
+ group: unit-${{ github.head_ref }}
10
+ cancel-in-progress: true
11
+
8
12
  jobs:
9
13
  pre-commit:
10
14
  runs-on: ubuntu-latest
@@ -0,0 +1,87 @@
1
+ name: Run Integration Tests
2
+
3
+ on:
4
+ pull_request:
5
+ branches:
6
+ - master
7
+ schedule:
8
+ - cron: "0 2 * * *"
9
+
10
+ concurrency:
11
+ group: integration-${{ github.head_ref }}
12
+ cancel-in-progress: true
13
+
14
+ jobs:
15
+ test_integration:
16
+ runs-on: ubuntu-latest
17
+ if: >
18
+ (github.event_name == 'pull_request' &&
19
+ github.event.pull_request.draft == false &&
20
+ !contains(github.event.pull_request.labels.*.name, 'ci/skip') &&
21
+ !contains(github.event.pull_request.head.ref, 'datadog-api-spec/test/') &&
22
+ contains(github.event.pull_request.labels.*.name, 'ci/integrations')) ||
23
+ github.event_name == 'schedule'
24
+ services:
25
+ datadog-agent:
26
+ image: datadog/agent:latest
27
+ ports:
28
+ - 8126:8126
29
+ env:
30
+ DD_API_KEY: ${{ secrets.DD_API_KEY }}
31
+ DD_HOSTNAME: "none"
32
+ DD_INSIDE_CI: "true"
33
+ steps:
34
+ - name: Get GitHub App token
35
+ if: github.event_name == 'pull_request'
36
+ id: get_token
37
+ uses: tibdex/github-app-token@v1.3.0
38
+ with:
39
+ app_id: ${{ secrets.PIPELINE_GITHUB_APP_ID }}
40
+ private_key: ${{ secrets.PIPELINE_GITHUB_APP_PRIVATE_KEY }}
41
+ repository: DataDog/datadog-api-spec
42
+ - name: Checkout code
43
+ uses: actions/checkout@v2
44
+ - name: Post pending status check
45
+ if: github.event_name == 'pull_request'
46
+ uses: actions/github-script@v4.0.2
47
+ with:
48
+ github-token: ${{ steps.get_token.outputs.token }}
49
+ script: |
50
+ const script = require('.github/workflows/scripts/test_integration.js')
51
+ await script.post_status_check(github, context, "pending")
52
+ - name: Set up Ruby 2.7
53
+ uses: ruby/setup-ruby@v1
54
+ with:
55
+ ruby-version: 2.7
56
+ bundler-cache: true
57
+ - name: Install deps
58
+ run: bundle install
59
+ - name: Run integration tests
60
+ run: ./run-tests.sh
61
+ shell: bash
62
+ env:
63
+ CI: "true"
64
+ DD_AGENT_HOST: localhost
65
+ DD_ENV: prod
66
+ DD_SERVICE: datadog-api-client-ruby
67
+ DD_TAGS: "team:integration-tools-and-libraries"
68
+ DD_TEST_CLIENT_API_KEY: ${{ secrets.DD_CLIENT_API_KEY }}
69
+ DD_TEST_CLIENT_APP_KEY: ${{ secrets.DD_CLIENT_APP_KEY }}
70
+ DD_TRACE_ANALYTICS_ENABLED: "true"
71
+ RECORD: "none"
72
+ - name: Post failure status check
73
+ if: failure() && github.event_name == 'pull_request'
74
+ uses: actions/github-script@v4.0.2
75
+ with:
76
+ github-token: ${{ steps.get_token.outputs.token }}
77
+ script: |
78
+ const script = require('./.github/workflows/scripts/test_integration.js')
79
+ await script.post_status_check(github, context, "failure")
80
+ - name: Post success status check
81
+ if: "!failure() && github.event_name == 'pull_request'"
82
+ uses: actions/github-script@v4.0.2
83
+ with:
84
+ github-token: ${{ steps.get_token.outputs.token }}
85
+ script: |
86
+ const script = require('./.github/workflows/scripts/test_integration.js')
87
+ await script.post_status_check(github, context, "success")
@@ -261,6 +261,22 @@ docs/RolesAPI.md
261
261
  docs/RolesResponse.md
262
262
  docs/RolesSort.md
263
263
  docs/RolesType.md
264
+ docs/SecurityFilter.md
265
+ docs/SecurityFilterAttributes.md
266
+ docs/SecurityFilterCreateAttributes.md
267
+ docs/SecurityFilterCreateData.md
268
+ docs/SecurityFilterCreateRequest.md
269
+ docs/SecurityFilterDeleteResponse.md
270
+ docs/SecurityFilterExclusionFilter.md
271
+ docs/SecurityFilterExclusionFilterResponse.md
272
+ docs/SecurityFilterFilteredDataType.md
273
+ docs/SecurityFilterMeta.md
274
+ docs/SecurityFilterResponse.md
275
+ docs/SecurityFilterType.md
276
+ docs/SecurityFilterUpdateAttributes.md
277
+ docs/SecurityFilterUpdateData.md
278
+ docs/SecurityFilterUpdateRequest.md
279
+ docs/SecurityFiltersResponse.md
264
280
  docs/SecurityMonitoringAPI.md
265
281
  docs/SecurityMonitoringFilter.md
266
282
  docs/SecurityMonitoringFilterAction.md
@@ -584,6 +600,22 @@ lib/datadog_api_client/v2/models/role_update_response_data.rb
584
600
  lib/datadog_api_client/v2/models/roles_response.rb
585
601
  lib/datadog_api_client/v2/models/roles_sort.rb
586
602
  lib/datadog_api_client/v2/models/roles_type.rb
603
+ lib/datadog_api_client/v2/models/security_filter.rb
604
+ lib/datadog_api_client/v2/models/security_filter_attributes.rb
605
+ lib/datadog_api_client/v2/models/security_filter_create_attributes.rb
606
+ lib/datadog_api_client/v2/models/security_filter_create_data.rb
607
+ lib/datadog_api_client/v2/models/security_filter_create_request.rb
608
+ lib/datadog_api_client/v2/models/security_filter_delete_response.rb
609
+ lib/datadog_api_client/v2/models/security_filter_exclusion_filter.rb
610
+ lib/datadog_api_client/v2/models/security_filter_exclusion_filter_response.rb
611
+ lib/datadog_api_client/v2/models/security_filter_filtered_data_type.rb
612
+ lib/datadog_api_client/v2/models/security_filter_meta.rb
613
+ lib/datadog_api_client/v2/models/security_filter_response.rb
614
+ lib/datadog_api_client/v2/models/security_filter_type.rb
615
+ lib/datadog_api_client/v2/models/security_filter_update_attributes.rb
616
+ lib/datadog_api_client/v2/models/security_filter_update_data.rb
617
+ lib/datadog_api_client/v2/models/security_filter_update_request.rb
618
+ lib/datadog_api_client/v2/models/security_filters_response.rb
587
619
  lib/datadog_api_client/v2/models/security_monitoring_filter.rb
588
620
  lib/datadog_api_client/v2/models/security_monitoring_filter_action.rb
589
621
  lib/datadog_api_client/v2/models/security_monitoring_list_rules_response.rb
@@ -903,6 +935,22 @@ spec/models/role_update_response_spec.rb
903
935
  spec/models/roles_response_spec.rb
904
936
  spec/models/roles_sort_spec.rb
905
937
  spec/models/roles_type_spec.rb
938
+ spec/models/security_filter_attributes_spec.rb
939
+ spec/models/security_filter_create_attributes_spec.rb
940
+ spec/models/security_filter_create_data_spec.rb
941
+ spec/models/security_filter_create_request_spec.rb
942
+ spec/models/security_filter_delete_response_spec.rb
943
+ spec/models/security_filter_exclusion_filter_response_spec.rb
944
+ spec/models/security_filter_exclusion_filter_spec.rb
945
+ spec/models/security_filter_filtered_data_type_spec.rb
946
+ spec/models/security_filter_meta_spec.rb
947
+ spec/models/security_filter_response_spec.rb
948
+ spec/models/security_filter_spec.rb
949
+ spec/models/security_filter_type_spec.rb
950
+ spec/models/security_filter_update_attributes_spec.rb
951
+ spec/models/security_filter_update_data_spec.rb
952
+ spec/models/security_filter_update_request_spec.rb
953
+ spec/models/security_filters_response_spec.rb
906
954
  spec/models/security_monitoring_filter_action_spec.rb
907
955
  spec/models/security_monitoring_filter_spec.rb
908
956
  spec/models/security_monitoring_list_rules_response_spec.rb
data/CHANGELOG.md CHANGED
@@ -1,5 +1,23 @@
1
1
  # CHANGELOG
2
2
 
3
+ ## 1.1.0 / 2021-06-08
4
+
5
+ * [Added] Add CWS to usage metering endpoint. See [#376](https://github.com/DataDog/datadog-api-client-ruby/pull/376).
6
+ * [Added] Add endpoint to list Synthetics global variables. See [#377](https://github.com/DataDog/datadog-api-client-ruby/pull/377).
7
+ * [Added] Add monitors search endpoint. See [#373](https://github.com/DataDog/datadog-api-client-ruby/pull/373).
8
+ * [Added] Add `tag_config_source` to usage attribution response. See [#368](https://github.com/DataDog/datadog-api-client-ruby/pull/368).
9
+ * [Added] Add endpoints to configure Security Filters. See [#359](https://github.com/DataDog/datadog-api-client-ruby/pull/359).
10
+ * [Added] Add `active_child` nested downtime object to `Downtime` component for downtime APIs. See [#354](https://github.com/DataDog/datadog-api-client-ruby/pull/354).
11
+ * [Added] Add `override_label` and `is_hidden` attribute for `WidgetCustomLink`. See [#358](https://github.com/DataDog/datadog-api-client-ruby/pull/358).
12
+ * [Added] Add audit logs to usage endpoints. See [#384](https://github.com/DataDog/datadog-api-client-ruby/pull/384).
13
+ * [Fixed] Fix type of day/month response attribute in custom metrics usage. See [#387](https://github.com/DataDog/datadog-api-client-ruby/pull/387).
14
+ * [Fixed] Make `assertions` field optional for multistep synthetics tests, and add `global` config variable type. See [#375](https://github.com/DataDog/datadog-api-client-ruby/pull/375).
15
+ * [Fixed] Properly mark monitor required fields. See [#366](https://github.com/DataDog/datadog-api-client-ruby/pull/366).
16
+ * [Fixed] Rename `incident_integration_metadata` to `incident_integrations` to match API. See [#362](https://github.com/DataDog/datadog-api-client-ruby/pull/362).
17
+ * [Fixed] Properly mark several synthetics attributes as read only. See [#357](https://github.com/DataDog/datadog-api-client-ruby/pull/357).
18
+ * [Fixed] Fix paging attributes of usage attribution endpoints. See [#355](https://github.com/DataDog/datadog-api-client-ruby/pull/355).
19
+ * [Changed] Rename `compliance` to `CSPM` in usage endpoint. See [#384](https://github.com/DataDog/datadog-api-client-ruby/pull/384).
20
+
3
21
  ## 1.0.0 / 2021-05-12
4
22
 
5
23
  * [Added] Notebooks Public API Documentation. See [#351](https://github.com/DataDog/datadog-api-client-ruby/pull/351).
data/README.md CHANGED
@@ -111,7 +111,7 @@ where `<unstable_operation_id>` is the name of the method used to interact with
111
111
 
112
112
  If you are interested in general documentation for all public Datadog API endpoints, checkout the [general documentation site](api docs).
113
113
 
114
- Developer documentation for supported endpoints and models is divided based on API version prefix to [`v1`](/docs/v1/README.md) and [`v2`](/docs/v1/README.md).
114
+ Developer documentation for supported endpoints and models is divided based on API version prefix to [`v1`](/docs/v1/README.md) and [`v2`](/docs/v2/README.md).
115
115
 
116
116
  For contributing, checkout the [contribution guidelines](contribution docs) and [development guide][development docs].
117
117
 
data/data/v1/openapi.yaml CHANGED
@@ -1258,6 +1258,8 @@ components:
1258
1258
  example: true
1259
1259
  readOnly: true
1260
1260
  type: boolean
1261
+ active_child:
1262
+ $ref: '#/components/schemas/DowntimeChild'
1261
1263
  canceled:
1262
1264
  description: If a scheduled downtime is canceled.
1263
1265
  example: 1412799983
@@ -1375,6 +1377,136 @@ components:
1375
1377
  readOnly: true
1376
1378
  type: integer
1377
1379
  type: object
1380
+ DowntimeChild:
1381
+ description: 'The downtime object definition of the active child for the original
1382
+ parent recurring downtime. This
1383
+
1384
+ field will only exist on recurring downtimes.'
1385
+ nullable: true
1386
+ properties:
1387
+ active:
1388
+ description: If a scheduled downtime currently exists.
1389
+ example: true
1390
+ readOnly: true
1391
+ type: boolean
1392
+ canceled:
1393
+ description: If a scheduled downtime is canceled.
1394
+ example: 1412799983
1395
+ format: int64
1396
+ nullable: true
1397
+ readOnly: true
1398
+ type: integer
1399
+ creator_id:
1400
+ description: User ID of the downtime creator.
1401
+ example: 123456
1402
+ format: int32
1403
+ maximum: 2147483647
1404
+ readOnly: true
1405
+ type: integer
1406
+ disabled:
1407
+ description: If a downtime has been disabled.
1408
+ example: false
1409
+ type: boolean
1410
+ downtime_type:
1411
+ description: '`0` for a downtime applied on `*` or all,
1412
+
1413
+ `1` when the downtime is only scoped to hosts,
1414
+
1415
+ or `2` when the downtime is scoped to anything but hosts.'
1416
+ example: 2
1417
+ format: int32
1418
+ maximum: 2147483647
1419
+ readOnly: true
1420
+ type: integer
1421
+ end:
1422
+ description: 'POSIX timestamp to end the downtime. If not provided,
1423
+
1424
+ the downtime is in effect indefinitely until you cancel it.'
1425
+ example: 1412793983
1426
+ format: int64
1427
+ nullable: true
1428
+ type: integer
1429
+ id:
1430
+ description: The downtime ID.
1431
+ example: 1626
1432
+ format: int64
1433
+ readOnly: true
1434
+ type: integer
1435
+ message:
1436
+ description: 'A message to include with notifications for this downtime.
1437
+
1438
+ Email notifications can be sent to specific users by using the same `@username`
1439
+ notation as events.'
1440
+ example: Message on the downtime
1441
+ type: string
1442
+ monitor_id:
1443
+ description: 'A single monitor to which the downtime applies.
1444
+
1445
+ If not provided, the downtime applies to all monitors.'
1446
+ example: 123456
1447
+ format: int64
1448
+ nullable: true
1449
+ type: integer
1450
+ monitor_tags:
1451
+ description: 'A comma-separated list of monitor tags. For example, tags
1452
+ that are applied directly to monitors,
1453
+
1454
+ not tags that are used in monitor queries (which are filtered by the scope
1455
+ parameter), to which the downtime applies.
1456
+
1457
+ The resulting downtime applies to monitors that match ALL provided monitor
1458
+ tags.
1459
+
1460
+ For example, `service:postgres` **AND** `team:frontend`.'
1461
+ example:
1462
+ - '*'
1463
+ items:
1464
+ description: A monitor tag.
1465
+ type: string
1466
+ type: array
1467
+ parent_id:
1468
+ description: ID of the parent Downtime.
1469
+ example: 123
1470
+ format: int64
1471
+ nullable: true
1472
+ type: integer
1473
+ recurrence:
1474
+ $ref: '#/components/schemas/DowntimeRecurrence'
1475
+ scope:
1476
+ description: 'The scope(s) to which the downtime applies. For example, `host:app2`.
1477
+
1478
+ Provide multiple scopes as a comma-separated list like `env:dev,env:prod`.
1479
+
1480
+ The resulting downtime applies to sources that matches ALL provided scopes
1481
+ (`env:dev` **AND** `env:prod`).'
1482
+ example:
1483
+ - env:staging
1484
+ items:
1485
+ description: A scope. For example, `"env:staging"`.
1486
+ type: string
1487
+ type: array
1488
+ start:
1489
+ description: 'POSIX timestamp to start the downtime.
1490
+
1491
+ If not provided, the downtime starts the moment it is created.'
1492
+ example: 1412792983
1493
+ format: int64
1494
+ type: integer
1495
+ timezone:
1496
+ description: The timezone in which to display the downtime's start and end
1497
+ times in Datadog applications.
1498
+ example: America/New_York
1499
+ type: string
1500
+ updater_id:
1501
+ description: ID of the last user that updated the downtime.
1502
+ example: 123456
1503
+ format: int32
1504
+ maximum: 2147483647
1505
+ nullable: true
1506
+ readOnly: true
1507
+ type: integer
1508
+ readOnly: true
1509
+ type: object
1378
1510
  DowntimeRecurrence:
1379
1511
  description: An object defining the recurrence of the downtime.
1380
1512
  nullable: true
@@ -4740,6 +4872,7 @@ components:
4740
4872
  type: integer
4741
4873
  query:
4742
4874
  description: The monitor query.
4875
+ example: avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100
4743
4876
  type: string
4744
4877
  restricted_roles:
4745
4878
  description: A list of role identifiers that can be pulled from the Roles
@@ -4758,6 +4891,9 @@ components:
4758
4891
  type: array
4759
4892
  type:
4760
4893
  $ref: '#/components/schemas/MonitorType'
4894
+ required:
4895
+ - type
4896
+ - query
4761
4897
  type: object
4762
4898
  MonitorDeviceID:
4763
4899
  description: ID of the device the Synthetics monitor is running on. Same as
@@ -4783,6 +4919,95 @@ components:
4783
4919
  - FIREFOX_LAPTOP_LARGE
4784
4920
  - FIREFOX_TABLET
4785
4921
  - FIREFOX_MOBILE_SMALL
4922
+ MonitorGroupSearchResponse:
4923
+ description: The response of a monitor group search.
4924
+ example:
4925
+ counts:
4926
+ status:
4927
+ - count: 2
4928
+ name: OK
4929
+ type:
4930
+ - count: 2
4931
+ name: metric
4932
+ groups:
4933
+ - group: '*'
4934
+ group_tags:
4935
+ - '*'
4936
+ last_nodata_ts: 0
4937
+ last_triggered_ts: 1525702966
4938
+ monitor_id: 2738266
4939
+ monitor_name: '[demo] Cassandra disk usage is high on {{host.name}}'
4940
+ status: OK
4941
+ - group: '*'
4942
+ group_tags:
4943
+ - '*'
4944
+ last_nodata_ts: 0
4945
+ last_triggered_ts: 1525703008
4946
+ monitor_id: 1576648
4947
+ monitor_name: '[demo] Disk usage is high on {{host.name}}'
4948
+ status: OK
4949
+ metadata:
4950
+ page: 0
4951
+ page_count: 2
4952
+ per_page: 30
4953
+ total_count: 2
4954
+ properties:
4955
+ counts:
4956
+ description: The counts of monitor groups per different criteria.
4957
+ properties:
4958
+ status:
4959
+ $ref: '#/components/schemas/MonitorSearchCount'
4960
+ type:
4961
+ $ref: '#/components/schemas/MonitorSearchCount'
4962
+ readOnly: true
4963
+ type: object
4964
+ groups:
4965
+ description: The list of found monitor groups.
4966
+ items:
4967
+ $ref: '#/components/schemas/MonitorGroupSearchResult'
4968
+ readOnly: true
4969
+ type: array
4970
+ metadata:
4971
+ $ref: '#/components/schemas/MonitorSearchResponseMetadata'
4972
+ type: object
4973
+ MonitorGroupSearchResult:
4974
+ description: A single monitor group search result.
4975
+ properties:
4976
+ group:
4977
+ description: The name of the group.
4978
+ readOnly: true
4979
+ type: string
4980
+ group_tags:
4981
+ description: The list of tags of the monitor group.
4982
+ items:
4983
+ description: One monitor group tag.
4984
+ readOnly: true
4985
+ type: string
4986
+ readOnly: true
4987
+ type: array
4988
+ last_nodata_ts:
4989
+ description: Latest timestamp the monitor group was in NO_DATA state.
4990
+ format: int64
4991
+ readOnly: true
4992
+ type: integer
4993
+ last_triggered_ts:
4994
+ description: Latest timestamp the monitor group triggered.
4995
+ format: int64
4996
+ nullable: true
4997
+ readOnly: true
4998
+ type: integer
4999
+ monitor_id:
5000
+ description: The ID of the monitor.
5001
+ format: int64
5002
+ readOnly: true
5003
+ type: integer
5004
+ monitor_name:
5005
+ description: The name of the monitor.
5006
+ readOnly: true
5007
+ type: string
5008
+ status:
5009
+ $ref: '#/components/schemas/MonitorOverallStates'
5010
+ type: object
4786
5011
  MonitorOptions:
4787
5012
  description: List of options associated with your monitor.
4788
5013
  properties:
@@ -4815,8 +5040,12 @@ components:
4815
5040
  type: boolean
4816
5041
  escalation_message:
4817
5042
  default: none
4818
- description: 'A message to include with a re-notification. Supports the
4819
- `@username` notification we allow elsewhere.
5043
+ description: 'We recommend using the [is_renotify](https://docs.datadoghq.com/monitors/notifications/?tab=is_alert#renotify),
5044
+
5045
+ block in the original message instead.
5046
+
5047
+ A message to include with a re-notification. Supports the `@username`
5048
+ notification we allow elsewhere.
4820
5049
 
4821
5050
  Not applicable if `renotify_interval` is `None`.'
4822
5051
  type: string
@@ -4965,6 +5194,199 @@ components:
4965
5194
  - SKIPPED
4966
5195
  - UNKNOWN
4967
5196
  - WARN
5197
+ MonitorSearchCount:
5198
+ description: Search facets.
5199
+ items:
5200
+ description: A facet item.
5201
+ properties:
5202
+ count:
5203
+ description: The number of found monitors with the listed value.
5204
+ format: int64
5205
+ readOnly: true
5206
+ type: integer
5207
+ name:
5208
+ description: The facet value.
5209
+ readOnly: true
5210
+ type: object
5211
+ type: array
5212
+ MonitorSearchResponse:
5213
+ description: The response form a monitor search.
5214
+ example:
5215
+ counts:
5216
+ muted:
5217
+ - count: 3
5218
+ name: false
5219
+ - count: 3
5220
+ name: true
5221
+ status:
5222
+ - count: 4
5223
+ name: No Data
5224
+ - count: 2
5225
+ name: OK
5226
+ tag:
5227
+ - count: 6
5228
+ name: service:cassandra
5229
+ type:
5230
+ - count: 6
5231
+ name: metric
5232
+ metadata:
5233
+ page: 0
5234
+ page_count: 6
5235
+ per_page: 30
5236
+ total_count: 6
5237
+ monitors:
5238
+ - classification: metric
5239
+ creator:
5240
+ handle: john@datadoghq.com
5241
+ name: John Doe
5242
+ id: 2699850
5243
+ last_triggered_ts: null
5244
+ metrics:
5245
+ - system.cpu.user
5246
+ name: Cassandra CPU is high on {{host.name}} in {{availability-zone.name}}
5247
+ notifications:
5248
+ - handle: jane@datadoghq.com
5249
+ name: Jane Doe
5250
+ org_id: 1234
5251
+ scopes:
5252
+ - '!availability-zone:us-east-1c'
5253
+ - name:cassandra
5254
+ status: No Data
5255
+ tags:
5256
+ - service:cassandra
5257
+ type: metric alert
5258
+ properties:
5259
+ counts:
5260
+ description: The counts of monitors per different criteria.
5261
+ properties:
5262
+ muted:
5263
+ $ref: '#/components/schemas/MonitorSearchCount'
5264
+ status:
5265
+ $ref: '#/components/schemas/MonitorSearchCount'
5266
+ tag:
5267
+ $ref: '#/components/schemas/MonitorSearchCount'
5268
+ type:
5269
+ $ref: '#/components/schemas/MonitorSearchCount'
5270
+ readOnly: true
5271
+ type: object
5272
+ metadata:
5273
+ $ref: '#/components/schemas/MonitorSearchResponseMetadata'
5274
+ monitors:
5275
+ description: The list of found monitors.
5276
+ items:
5277
+ $ref: '#/components/schemas/MonitorSearchResult'
5278
+ readOnly: true
5279
+ type: array
5280
+ type: object
5281
+ MonitorSearchResponseMetadata:
5282
+ description: Metadata about the response.
5283
+ properties:
5284
+ page:
5285
+ description: The page to start paginating from.
5286
+ format: int64
5287
+ readOnly: true
5288
+ type: integer
5289
+ page_count:
5290
+ description: The number of pages.
5291
+ format: int64
5292
+ readOnly: true
5293
+ type: integer
5294
+ per_page:
5295
+ description: The number of monitors to return per page.
5296
+ format: int64
5297
+ readOnly: true
5298
+ type: integer
5299
+ total_count:
5300
+ description: The total number of monitors.
5301
+ format: int64
5302
+ readOnly: true
5303
+ type: integer
5304
+ type: object
5305
+ MonitorSearchResult:
5306
+ description: Holds search results.
5307
+ properties:
5308
+ classification:
5309
+ description: Classification of the monitor.
5310
+ readOnly: true
5311
+ type: string
5312
+ creator:
5313
+ $ref: '#/components/schemas/Creator'
5314
+ id:
5315
+ description: ID of the monitor.
5316
+ format: int64
5317
+ readOnly: true
5318
+ type: integer
5319
+ last_triggered_ts:
5320
+ description: Latest timestamp the monitor triggered.
5321
+ format: int64
5322
+ nullable: true
5323
+ readOnly: true
5324
+ type: integer
5325
+ metrics:
5326
+ description: Metrics used by the monitor.
5327
+ items:
5328
+ description: A metric used by the monitor.
5329
+ readOnly: true
5330
+ type: string
5331
+ readOnly: true
5332
+ type: array
5333
+ name:
5334
+ description: The monitor name.
5335
+ readOnly: true
5336
+ type: string
5337
+ notifications:
5338
+ description: The notification triggered by the monitor.
5339
+ items:
5340
+ $ref: '#/components/schemas/MonitorSearchResultNotification'
5341
+ readOnly: true
5342
+ type: array
5343
+ org_id:
5344
+ description: The ID of the organization.
5345
+ format: int64
5346
+ readOnly: true
5347
+ type: integer
5348
+ scopes:
5349
+ description: 'The scope(s) to which the downtime applies, e.g. `host:app2`.
5350
+
5351
+ Provide multiple scopes as a comma-separated list, e.g. `env:dev,env:prod`.
5352
+
5353
+ The resulting downtime applies to sources that matches ALL provided scopes
5354
+
5355
+ (i.e. `env:dev AND env:prod`), NOT any of them.'
5356
+ example:
5357
+ - host:app2
5358
+ - env:dev,env:prod
5359
+ items:
5360
+ description: Scope value(s).
5361
+ readOnly: true
5362
+ type: string
5363
+ type: array
5364
+ status:
5365
+ $ref: '#/components/schemas/MonitorOverallStates'
5366
+ tags:
5367
+ description: Tags associated with the monitor.
5368
+ items:
5369
+ description: A tag associated with the monitor.
5370
+ readOnly: true
5371
+ type: string
5372
+ readOnly: true
5373
+ type: array
5374
+ type:
5375
+ $ref: '#/components/schemas/MonitorType'
5376
+ type: object
5377
+ MonitorSearchResultNotification:
5378
+ description: A notification triggered by the monitor.
5379
+ properties:
5380
+ handle:
5381
+ description: The email address that received the notification.
5382
+ readOnly: true
5383
+ type: string
5384
+ name:
5385
+ description: The username receiving the notification
5386
+ readOnly: true
5387
+ type: string
5388
+ readOnly: true
5389
+ type: object
4968
5390
  MonitorState:
4969
5391
  description: Wrapper object with the different monitor states.
4970
5392
  properties:
@@ -5125,6 +5547,7 @@ components:
5125
5547
  - trace-analytics alert
5126
5548
  - slo alert
5127
5549
  - event-v2 alert
5550
+ example: metric alert
5128
5551
  type: string
5129
5552
  x-enum-varnames:
5130
5553
  - COMPOSITE
@@ -5274,6 +5697,7 @@ components:
5274
5697
  required:
5275
5698
  - start
5276
5699
  - end
5700
+ type: object
5277
5701
  NotebookAuthor:
5278
5702
  description: Attributes of user object returned by the API.
5279
5703
  properties:
@@ -5497,7 +5921,7 @@ components:
5497
5921
  $ref: '#/components/schemas/NotebookCellCreateRequest'
5498
5922
  type: array
5499
5923
  name:
5500
- description: Notebook name.
5924
+ description: The name of the notebook.
5501
5925
  example: Example Notebook
5502
5926
  maxLength: 80
5503
5927
  minLength: 0
@@ -5520,7 +5944,7 @@ components:
5520
5944
  - data
5521
5945
  type: object
5522
5946
  NotebookDistributionCellAttributes:
5523
- description: The attributes of a notebook distribution cell.
5947
+ description: The attributes of a notebook `distribution` cell.
5524
5948
  properties:
5525
5949
  definition:
5526
5950
  $ref: '#/components/schemas/DistributionWidgetDefinition'
@@ -5547,6 +5971,7 @@ components:
5547
5971
  - m
5548
5972
  - l
5549
5973
  - xl
5974
+ example: m
5550
5975
  type: string
5551
5976
  x-enum-varnames:
5552
5977
  - EXTRA_SMALL
@@ -5555,7 +5980,7 @@ components:
5555
5980
  - LARGE
5556
5981
  - EXTRA_LARGE
5557
5982
  NotebookHeatMapCellAttributes:
5558
- description: The attributes of a notebook heat map cell.
5983
+ description: The attributes of a notebook `heatmap` cell.
5559
5984
  properties:
5560
5985
  definition:
5561
5986
  $ref: '#/components/schemas/HeatMapWidgetDefinition'
@@ -5569,7 +5994,7 @@ components:
5569
5994
  - definition
5570
5995
  type: object
5571
5996
  NotebookLogStreamCellAttributes:
5572
- description: The attributes of a notebook log stream cell.
5997
+ description: The attributes of a notebook `log_stream` cell.
5573
5998
  properties:
5574
5999
  definition:
5575
6000
  $ref: '#/components/schemas/LogStreamWidgetDefinition'
@@ -5581,7 +6006,7 @@ components:
5581
6006
  - definition
5582
6007
  type: object
5583
6008
  NotebookMarkdownCellAttributes:
5584
- description: The attributes of a notebooks markdown cell.
6009
+ description: The attributes of a notebook `markdown` cell.
5585
6010
  properties:
5586
6011
  definition:
5587
6012
  $ref: '#/components/schemas/NotebookMarkdownCellDefinition'
@@ -5704,19 +6129,19 @@ components:
5704
6129
  $ref: '#/components/schemas/NotebookCellResponse'
5705
6130
  type: array
5706
6131
  created:
5707
- description: UTC time stamp.
6132
+ description: UTC time stamp for when the notebook was created.
5708
6133
  example: '2021-02-24T23:14:15.173964+00:00'
5709
6134
  format: date-time
5710
6135
  readOnly: true
5711
6136
  type: string
5712
6137
  modified:
5713
- description: UTC time stamp.
6138
+ description: UTC time stamp for when the notebook was last modified.
5714
6139
  example: '2021-02-24T23:15:23.274966+00:00'
5715
6140
  format: date-time
5716
6141
  readOnly: true
5717
6142
  type: string
5718
6143
  name:
5719
- description: Notebook name.
6144
+ description: The name of the notebook.
5720
6145
  example: Example Notebook
5721
6146
  maxLength: 80
5722
6147
  minLength: 0
@@ -5733,6 +6158,9 @@ components:
5733
6158
  NotebookSplitBy:
5734
6159
  description: Object describing how to split the graph to display multiple visualizations
5735
6160
  per request.
6161
+ example:
6162
+ keys: []
6163
+ tags: []
5736
6164
  properties:
5737
6165
  keys:
5738
6166
  description: Keys to split on.
@@ -5762,7 +6190,7 @@ components:
5762
6190
  x-enum-varnames:
5763
6191
  - PUBLISHED
5764
6192
  NotebookTimeseriesCellAttributes:
5765
- description: The attributes of a notebook timeseries cell.
6193
+ description: The attributes of a notebook `timeseries` cell.
5766
6194
  properties:
5767
6195
  definition:
5768
6196
  $ref: '#/components/schemas/TimeseriesWidgetDefinition'
@@ -5776,7 +6204,7 @@ components:
5776
6204
  - definition
5777
6205
  type: object
5778
6206
  NotebookToplistCellAttributes:
5779
- description: The attributes of a notebook toplist cell.
6207
+ description: The attributes of a notebook `toplist` cell.
5780
6208
  properties:
5781
6209
  definition:
5782
6210
  $ref: '#/components/schemas/ToplistWidgetDefinition'
@@ -5856,7 +6284,7 @@ components:
5856
6284
  $ref: '#/components/schemas/NotebookUpdateCell'
5857
6285
  type: array
5858
6286
  name:
5859
- description: Notebook name.
6287
+ description: The name of the notebook.
5860
6288
  example: Example Notebook
5861
6289
  maxLength: 80
5862
6290
  minLength: 0
@@ -5884,7 +6312,7 @@ components:
5884
6312
  data:
5885
6313
  description: List of notebook definitions.
5886
6314
  items:
5887
- $ref: '#/components/schemas/NotebookResponseData'
6315
+ $ref: '#/components/schemas/NotebooksResponseData'
5888
6316
  type: array
5889
6317
  meta:
5890
6318
  description: Metadata returned by the API.
@@ -5893,6 +6321,59 @@ components:
5893
6321
  $ref: '#/components/schemas/NotebooksResponsePage'
5894
6322
  type: object
5895
6323
  type: object
6324
+ NotebooksResponseData:
6325
+ description: The data for a notebook in get all response.
6326
+ properties:
6327
+ attributes:
6328
+ $ref: '#/components/schemas/NotebooksResponseDataAttributes'
6329
+ id:
6330
+ description: Unique notebook ID, assigned when you create the notebook.
6331
+ example: 123456
6332
+ format: int64
6333
+ readOnly: true
6334
+ type: integer
6335
+ type:
6336
+ $ref: '#/components/schemas/NotebookResourceType'
6337
+ required:
6338
+ - id
6339
+ - type
6340
+ - attributes
6341
+ type: object
6342
+ NotebooksResponseDataAttributes:
6343
+ description: The attributes of a notebook in get all response.
6344
+ properties:
6345
+ author:
6346
+ $ref: '#/components/schemas/NotebookAuthor'
6347
+ cells:
6348
+ description: List of cells to display in the notebook.
6349
+ items:
6350
+ $ref: '#/components/schemas/NotebookCellResponse'
6351
+ type: array
6352
+ created:
6353
+ description: UTC time stamp for when the notebook was created.
6354
+ example: '2021-02-24T23:14:15.173964+00:00'
6355
+ format: date-time
6356
+ readOnly: true
6357
+ type: string
6358
+ modified:
6359
+ description: UTC time stamp for when the notebook was last modified.
6360
+ example: '2021-02-24T23:15:23.274966+00:00'
6361
+ format: date-time
6362
+ readOnly: true
6363
+ type: string
6364
+ name:
6365
+ description: The name of the notebook.
6366
+ example: Example Notebook
6367
+ maxLength: 80
6368
+ minLength: 0
6369
+ type: string
6370
+ status:
6371
+ $ref: '#/components/schemas/NotebookStatus'
6372
+ time:
6373
+ $ref: '#/components/schemas/NotebookGlobalTime'
6374
+ required:
6375
+ - name
6376
+ type: object
5896
6377
  NotebooksResponsePage:
5897
6378
  description: Pagination metadata returned by the API.
5898
6379
  properties:
@@ -7813,6 +8294,7 @@ components:
7813
8294
  monitor_id:
7814
8295
  description: The associated monitor ID.
7815
8296
  format: int64
8297
+ readOnly: true
7816
8298
  type: integer
7817
8299
  name:
7818
8300
  description: Name of the test.
@@ -7821,6 +8303,7 @@ components:
7821
8303
  $ref: '#/components/schemas/SyntheticsTestOptions'
7822
8304
  public_id:
7823
8305
  description: The public ID for the test.
8306
+ readOnly: true
7824
8307
  type: string
7825
8308
  status:
7826
8309
  $ref: '#/components/schemas/SyntheticsTestPauseStatus'
@@ -7857,8 +8340,6 @@ components:
7857
8340
  items:
7858
8341
  $ref: '#/components/schemas/SyntheticsAPIStep'
7859
8342
  type: array
7860
- required:
7861
- - assertions
7862
8343
  type: object
7863
8344
  SyntheticsAPITestResultData:
7864
8345
  description: Object containing results for your Synthetic API test.
@@ -8151,6 +8632,7 @@ components:
8151
8632
  monitor_id:
8152
8633
  description: The associated monitor ID.
8153
8634
  format: int64
8635
+ readOnly: true
8154
8636
  type: integer
8155
8637
  name:
8156
8638
  description: Name of the test.
@@ -8159,6 +8641,7 @@ components:
8159
8641
  $ref: '#/components/schemas/SyntheticsTestOptions'
8160
8642
  public_id:
8161
8643
  description: The public ID of the test.
8644
+ readOnly: true
8162
8645
  type: string
8163
8646
  status:
8164
8647
  $ref: '#/components/schemas/SyntheticsTestPauseStatus'
@@ -8489,6 +8972,9 @@ components:
8489
8972
  example:
8490
8973
  description: Example for the variable.
8491
8974
  type: string
8975
+ id:
8976
+ description: ID of the variable for global variables.
8977
+ type: string
8492
8978
  name:
8493
8979
  description: Name of the variable.
8494
8980
  example: VARIABLE_NAME
@@ -8499,16 +8985,17 @@ components:
8499
8985
  type:
8500
8986
  $ref: '#/components/schemas/SyntheticsConfigVariableType'
8501
8987
  required:
8502
- - example
8503
8988
  - type
8504
8989
  - name
8505
8990
  type: object
8506
8991
  SyntheticsConfigVariableType:
8507
8992
  description: Type of the configuration variable.
8508
8993
  enum:
8994
+ - global
8509
8995
  - text
8510
8996
  type: string
8511
8997
  x-enum-varnames:
8998
+ - GLOBAL
8512
8999
  - TEXT
8513
9000
  SyntheticsCoreWebVitals:
8514
9001
  description: Core Web Vitals attached to a browser test step.
@@ -8750,8 +9237,15 @@ components:
8750
9237
  the value will not be present if the variable is secure.'
8751
9238
  example: example-value
8752
9239
  type: string
8753
- required:
8754
- - value
9240
+ type: object
9241
+ SyntheticsListGlobalVariablesResponse:
9242
+ description: Object containing an array of Synthetic global variables.
9243
+ properties:
9244
+ variables:
9245
+ description: Array of Synthetic global variables.
9246
+ items:
9247
+ $ref: '#/components/schemas/SyntheticsGlobalVariable'
9248
+ type: array
8755
9249
  type: object
8756
9250
  SyntheticsListTestsResponse:
8757
9251
  description: Object containing an array of Synthetic tests configuration.
@@ -9152,8 +9646,6 @@ components:
9152
9646
  items:
9153
9647
  $ref: '#/components/schemas/SyntheticsBrowserVariable'
9154
9648
  type: array
9155
- required:
9156
- - assertions
9157
9649
  type: object
9158
9650
  SyntheticsTestDetails:
9159
9651
  description: Object containing details about your Synthetic test.
@@ -9172,6 +9664,7 @@ components:
9172
9664
  monitor_id:
9173
9665
  description: The associated monitor ID.
9174
9666
  format: int64
9667
+ readOnly: true
9175
9668
  type: integer
9176
9669
  name:
9177
9670
  description: Name of the test.
@@ -9180,6 +9673,7 @@ components:
9180
9673
  $ref: '#/components/schemas/SyntheticsTestOptions'
9181
9674
  public_id:
9182
9675
  description: The test public ID.
9676
+ readOnly: true
9183
9677
  type: string
9184
9678
  status:
9185
9679
  $ref: '#/components/schemas/SyntheticsTestPauseStatus'
@@ -10020,6 +10514,11 @@ components:
10020
10514
  public_id:
10021
10515
  description: The organization public ID.
10022
10516
  type: string
10517
+ tag_config_source:
10518
+ description: The source of the usage attribution tag configuration and the
10519
+ selected tags in the format `<source_org_name>:<selected tag 1>-<selected
10520
+ tag 2>-<selected tag 3>`.
10521
+ type: string
10023
10522
  tags:
10024
10523
  $ref: '#/components/schemas/UsageAttributionTagNames'
10025
10524
  updated_at:
@@ -10038,24 +10537,18 @@ components:
10038
10537
  $ref: '#/components/schemas/UsageAttributionPagination'
10039
10538
  type: object
10040
10539
  UsageAttributionPagination:
10041
- description: The page count for the current pagination.
10540
+ description: The metadata for the current pagination.
10042
10541
  properties:
10043
10542
  limit:
10044
10543
  description: Maximum amount of records to be returned.
10045
10544
  format: int64
10046
10545
  type: integer
10047
- offset:
10048
- description: Records to be skipped before beginning to return.
10049
- format: int64
10050
- type: integer
10051
- sort_direction:
10052
- description: Direction to sort by.
10053
- type: string
10054
- sort_name:
10055
- description: Field to sort by.
10546
+ next_record_id:
10547
+ description: The cursor to use to get the next results, if any. To make
10548
+ the next request, use the same parameters with the addition of this next_record_id.
10056
10549
  type: string
10057
10550
  total_number_of_records:
10058
- description: Total number of records.
10551
+ description: Total number of records. (deprecated after May 1st, 2021)
10059
10552
  format: int64
10060
10553
  type: integer
10061
10554
  type: object
@@ -10237,6 +10730,23 @@ components:
10237
10730
  description: The custom metrics usage by tag(s).
10238
10731
  format: double
10239
10732
  type: number
10733
+ cws_container_percentage:
10734
+ description: The percentage of Cloud Workload Security container usage by
10735
+ tag(s)
10736
+ format: double
10737
+ type: number
10738
+ cws_container_usage:
10739
+ description: The Cloud Workload Security container usage by tag(s)
10740
+ format: double
10741
+ type: number
10742
+ cws_host_percentage:
10743
+ description: The percentage of Cloud Workload Security host usage by tag(s)
10744
+ format: double
10745
+ type: number
10746
+ cws_host_usage:
10747
+ description: The Cloud Workload Security host usage by tag(s)
10748
+ format: double
10749
+ type: number
10240
10750
  infra_host_percentage:
10241
10751
  description: The percentage of infrastructure host usage by tag(s).
10242
10752
  format: double
@@ -10308,6 +10818,29 @@ components:
10308
10818
  format: double
10309
10819
  type: number
10310
10820
  type: object
10821
+ UsageAuditLogsHour:
10822
+ description: Audit logs usage for a given organization for a given hour.
10823
+ properties:
10824
+ hour:
10825
+ description: The hour for the usage.
10826
+ format: date-time
10827
+ type: string
10828
+ lines_indexed:
10829
+ description: The total number of audit logs lines indexed during a given
10830
+ hour.
10831
+ format: int64
10832
+ type: integer
10833
+ type: object
10834
+ UsageAuditLogsResponse:
10835
+ description: Response containing the audit logs usage for each hour for a given
10836
+ organization.
10837
+ properties:
10838
+ usage:
10839
+ description: Get hourly usage for audit logs.
10840
+ items:
10841
+ $ref: '#/components/schemas/UsageAuditLogsHour'
10842
+ type: array
10843
+ type: object
10311
10844
  UsageBillableSummaryBody:
10312
10845
  description: Response with properties for each aggregated usage type.
10313
10846
  properties:
@@ -10421,18 +10954,18 @@ components:
10421
10954
  $ref: '#/components/schemas/UsageBillableSummaryHour'
10422
10955
  type: array
10423
10956
  type: object
10424
- UsageComplianceHour:
10425
- description: Compliance Monitoring usage for a given organization for a given
10957
+ UsageCWSHour:
10958
+ description: Cloud Workload Security usage for a given organization for a given
10426
10959
  hour.
10427
10960
  properties:
10428
- compliance_container_count:
10429
- description: The total number of compliance container hours from the start
10430
- of the given hour's month until the given hour.
10961
+ cws_container_count:
10962
+ description: "The total number of Cloud Workload Security container hours\
10963
+ \ from the start of the given hour\u2019s month until the given hour."
10431
10964
  format: int64
10432
10965
  type: integer
10433
- compliance_host_count:
10434
- description: The total number of compliance hosts hours from the start of
10435
- the given hour's month until the given hour.
10966
+ cws_host_count:
10967
+ description: "The total number of Cloud Workload Security host hours from\
10968
+ \ the start of the given hour\u2019s month until the given hour."
10436
10969
  format: int64
10437
10970
  type: integer
10438
10971
  hour:
@@ -10440,14 +10973,43 @@ components:
10440
10973
  format: date-time
10441
10974
  type: string
10442
10975
  type: object
10443
- UsageComplianceResponse:
10444
- description: The response containing the Compliance Monitoring usage for each
10976
+ UsageCWSResponse:
10977
+ description: Response containing the Cloud Workload Security usage for each
10445
10978
  hour for a given organization.
10446
10979
  properties:
10447
10980
  usage:
10448
- description: Get hourly usage for Compliance Monitoring.
10981
+ description: Get hourly usage for Cloud Workload Security.
10982
+ items:
10983
+ $ref: '#/components/schemas/UsageCWSHour'
10984
+ type: array
10985
+ type: object
10986
+ UsageCloudSecurityPostureManagementHour:
10987
+ description: Cloud Security Posture Management usage for a given organization
10988
+ for a given hour.
10989
+ properties:
10990
+ container_count:
10991
+ description: The total number of Cloud Security Posture Management containers
10992
+ during a given hour.
10993
+ format: int64
10994
+ type: integer
10995
+ host_count:
10996
+ description: The total number of Cloud Security Posture Management hosts
10997
+ during a given hour.
10998
+ format: int64
10999
+ type: integer
11000
+ hour:
11001
+ description: The hour for the usage.
11002
+ format: date-time
11003
+ type: string
11004
+ type: object
11005
+ UsageCloudSecurityPostureManagementResponse:
11006
+ description: The response containing the Cloud Security Posture Management usage
11007
+ for each hour for a given organization.
11008
+ properties:
11009
+ usage:
11010
+ description: Get hourly usage for Cloud Security Posture Management.
10449
11011
  items:
10450
- $ref: '#/components/schemas/UsageComplianceHour'
11012
+ $ref: '#/components/schemas/UsageCloudSecurityPostureManagementHour'
10451
11013
  type: array
10452
11014
  type: object
10453
11015
  UsageCustomReportsAttributes:
@@ -11115,6 +11677,11 @@ components:
11115
11677
  hours in the current date for all organizations.
11116
11678
  format: int64
11117
11679
  type: integer
11680
+ audit_logs_lines_indexed_sum:
11681
+ description: Shows the sum of audit logs lines indexed over all hours in
11682
+ the current date for all organizations.
11683
+ format: int64
11684
+ type: integer
11118
11685
  aws_host_top99p:
11119
11686
  description: Shows the 99th percentile of all AWS hosts over all hours in
11120
11687
  the current date for all organizations.
@@ -11140,14 +11707,6 @@ components:
11140
11707
  current date for all organizations.
11141
11708
  format: int64
11142
11709
  type: integer
11143
- compliance_container_count_sum:
11144
- description: Shows the sum of compliance containers over all hours in the
11145
- current date for all organizations.
11146
- compliance_host_count_sum:
11147
- description: Shows the sum of compliance hosts over all hours in the current
11148
- date for all organizations.
11149
- format: int64
11150
- type: integer
11151
11710
  container_avg:
11152
11711
  description: Shows the average of all distinct containers over all hours
11153
11712
  in the current date for all organizations.
@@ -11158,11 +11717,36 @@ components:
11158
11717
  hours in the current date for all organizations.
11159
11718
  format: int64
11160
11719
  type: integer
11720
+ cspm_container_avg:
11721
+ description: Shows the average number of Cloud Security Posture Management
11722
+ containers over all hours in the current date for all organizations.
11723
+ format: int64
11724
+ type: integer
11725
+ cspm_container_hwm:
11726
+ description: Shows the high-water mark of Cloud Security Posture Management
11727
+ containers over all hours in the current date for all organizations.
11728
+ format: int64
11729
+ type: integer
11730
+ cspm_host_top99p:
11731
+ description: Shows the 99th percentile of all Cloud Security Posture Management
11732
+ hosts over all hours in the current date for all organizations.
11733
+ format: int64
11734
+ type: integer
11161
11735
  custom_ts_avg:
11162
11736
  description: Shows the average number of distinct custom metrics over all
11163
11737
  hours in the current date for all organizations.
11164
11738
  format: int64
11165
11739
  type: integer
11740
+ cws_container_count_avg:
11741
+ description: Shows the average of all distinct Cloud Workload Security containers
11742
+ over all hours in the current date for all organizations.
11743
+ format: int64
11744
+ type: integer
11745
+ cws_host_top99p:
11746
+ description: Shows the 99th percentile of all Cloud Workload Security hosts
11747
+ over all hours in the current date for all organizations.
11748
+ format: int64
11749
+ type: integer
11166
11750
  date:
11167
11751
  description: The date for the usage.
11168
11752
  format: date-time
@@ -11313,6 +11897,11 @@ components:
11313
11897
  hours in the current date for the given org.
11314
11898
  format: int64
11315
11899
  type: integer
11900
+ audit_logs_lines_indexed_sum:
11901
+ description: Shows the sum of all audit logs lines indexed over all hours
11902
+ in the current date for the given org.
11903
+ format: int64
11904
+ type: integer
11316
11905
  aws_host_top99p:
11317
11906
  description: Shows the 99th percentile of all AWS hosts over all hours in
11318
11907
  the current date for the given org.
@@ -11338,14 +11927,6 @@ components:
11338
11927
  current date for the given org.
11339
11928
  format: int64
11340
11929
  type: integer
11341
- compliance_container_agg_sum:
11342
- description: Shows the sum of all compliance containers over all hours in
11343
- the current date for the given org.
11344
- compliance_host_agg_sum:
11345
- description: Shows the sum of all compliance hosts over all hours in the
11346
- current date for the given org.
11347
- format: int64
11348
- type: integer
11349
11930
  container_avg:
11350
11931
  description: Shows the average of all distinct containers over all hours
11351
11932
  in the current date for the given org.
@@ -11356,11 +11937,36 @@ components:
11356
11937
  hours in the current date for the given org.
11357
11938
  format: int64
11358
11939
  type: integer
11940
+ cspm_container_avg:
11941
+ description: Shows the average number of Cloud Security Posture Management
11942
+ containers over all hours in the current date for the given org.
11943
+ format: int64
11944
+ type: integer
11945
+ cspm_container_hwm:
11946
+ description: Shows the high-water mark of Cloud Security Posture Management
11947
+ containers over all hours in the current date for the given org.
11948
+ format: int64
11949
+ type: integer
11950
+ cspm_host_top99p:
11951
+ description: Shows the 99th percentile of all Cloud Security Posture Management
11952
+ hosts over all hours in the current date for the given org.
11953
+ format: int64
11954
+ type: integer
11359
11955
  custom_ts_avg:
11360
11956
  description: Shows the average number of distinct custom metrics over all
11361
11957
  hours in the current date for the given org.
11362
11958
  format: int64
11363
11959
  type: integer
11960
+ cws_container_count_avg:
11961
+ description: Shows the average of all distinct Cloud Workload Security containers
11962
+ over all hours in the current date for the given org.
11963
+ format: int64
11964
+ type: integer
11965
+ cws_host_top99p:
11966
+ description: Shows the 99th percentile of all Cloud Workload Security hosts
11967
+ over all hours in the current date for the given org.
11968
+ format: int64
11969
+ type: integer
11364
11970
  fargate_tasks_count_avg:
11365
11971
  description: The average task count for Fargate.
11366
11972
  format: int64
@@ -11509,6 +12115,11 @@ components:
11509
12115
  hours in the current months for all organizations.
11510
12116
  format: int64
11511
12117
  type: integer
12118
+ audit_logs_lines_indexed_agg_sum:
12119
+ description: Shows the sum of all audit logs lines indexed over all hours
12120
+ in the current months for all organizations.
12121
+ format: int64
12122
+ type: integer
11512
12123
  aws_host_top99p_sum:
11513
12124
  description: Shows the 99th percentile of all AWS hosts over all hours in
11514
12125
  the current months for all organizations.
@@ -11539,14 +12150,6 @@ components:
11539
12150
  current months for all organizations.
11540
12151
  format: int64
11541
12152
  type: integer
11542
- compliance_container_agg_sum:
11543
- description: Shows the sum of all compliance containers over all hours in
11544
- the current months for all organizations.
11545
- compliance_host_agg_sum:
11546
- description: Shows the sum of all compliance hosts over all hours in the
11547
- current months for all organizations.
11548
- format: int64
11549
- type: integer
11550
12153
  container_avg_sum:
11551
12154
  description: Shows the average of all distinct containers over all hours
11552
12155
  in the current months for all organizations.
@@ -11557,11 +12160,37 @@ components:
11557
12160
  over all hours in the current months for all organizations.
11558
12161
  format: int64
11559
12162
  type: integer
12163
+ cspm_container_avg_sum:
12164
+ description: Shows the average number of Cloud Security Posture Management
12165
+ containers over all hours in the current months for all organizations.
12166
+ format: int64
12167
+ type: integer
12168
+ cspm_container_hwm_sum:
12169
+ description: Shows the sum of the the high-water marks of Cloud Security
12170
+ Posture Management containers over all hours in the current months for
12171
+ all organizations.
12172
+ format: int64
12173
+ type: integer
12174
+ cspm_host_top99p_sum:
12175
+ description: Shows the 99th percentile of all Cloud Security Posture Management
12176
+ hosts over all hours in the current months for all organizations.
12177
+ format: int64
12178
+ type: integer
11560
12179
  custom_ts_sum:
11561
12180
  description: Shows the average number of distinct custom metrics over all
11562
12181
  hours in the current months for all organizations.
11563
12182
  format: int64
11564
12183
  type: integer
12184
+ cws_containers_avg_sum:
12185
+ description: Shows the average of all distinct Cloud Workload Security containers
12186
+ over all hours in the current months for all organizations.
12187
+ format: int64
12188
+ type: integer
12189
+ cws_host_top99p_sum:
12190
+ description: Shows the 99th percentile of all Cloud Workload Security hosts
12191
+ over all hours in the current months for all organizations.
12192
+ format: int64
12193
+ type: integer
11565
12194
  end_date:
11566
12195
  description: Shows the last date of usage in the current months for all
11567
12196
  organizations.
@@ -11857,9 +12486,13 @@ components:
11857
12486
  day:
11858
12487
  description: The day value from the user request that contains the returned
11859
12488
  usage data. (If day was used the request)
12489
+ format: date-time
12490
+ type: string
11860
12491
  month:
11861
12492
  description: The month value from the user request that contains the returned
11862
12493
  usage data. (If month was used the request)
12494
+ format: date-time
12495
+ type: string
11863
12496
  pagination:
11864
12497
  $ref: '#/components/schemas/UsageAttributionPagination'
11865
12498
  type: object
@@ -12121,6 +12754,9 @@ components:
12121
12754
  description: Custom links help you connect a data value to a URL, like a Datadog
12122
12755
  page or your AWS console.
12123
12756
  properties:
12757
+ is_hidden:
12758
+ description: The flag for toggling context menu link visibility.
12759
+ type: boolean
12124
12760
  label:
12125
12761
  description: The label for the custom link URL. Keep the label short and
12126
12762
  descriptive. Use metrics and tags as variables.
@@ -12131,9 +12767,11 @@ components:
12131
12767
  A relative URL must start with `/`.
12132
12768
  example: https://app.datadoghq.com/logs?query={{host}}
12133
12769
  type: string
12134
- required:
12135
- - label
12136
- - link
12770
+ override_label:
12771
+ description: The label ID that refers to a context menu link. Can be `logs`,
12772
+ `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.
12773
+ example: logs
12774
+ type: string
12137
12775
  type: object
12138
12776
  WidgetDefinition:
12139
12777
  description: '[Definition of the widget](https://docs.datadoghq.com/dashboards/widgets/).'
@@ -16556,6 +17194,7 @@ paths:
16556
17194
  name: group_states
16557
17195
  required: false
16558
17196
  schema:
17197
+ example: alert
16559
17198
  type: string
16560
17199
  - description: A string to filter monitors by name.
16561
17200
  in: query
@@ -16571,6 +17210,7 @@ paths:
16571
17210
  name: tags
16572
17211
  required: false
16573
17212
  schema:
17213
+ example: host:host0
16574
17214
  type: string
16575
17215
  - description: 'A comma separated list indicating what service and/or custom
16576
17216
  tags, if any, should be used to filter the list of monitors.
@@ -16581,6 +17221,7 @@ paths:
16581
17221
  name: monitor_tags
16582
17222
  required: false
16583
17223
  schema:
17224
+ example: service:my-app
16584
17225
  type: string
16585
17226
  - description: If this argument is set to true, then the returned data includes
16586
17227
  all current downtimes for each monitor.
@@ -16602,6 +17243,7 @@ paths:
16602
17243
  name: page
16603
17244
  required: false
16604
17245
  schema:
17246
+ example: 0
16605
17247
  format: int64
16606
17248
  type: integer
16607
17249
  - description: The number of monitors to return per page. If the page argument
@@ -16612,6 +17254,7 @@ paths:
16612
17254
  name: page_size
16613
17255
  required: false
16614
17256
  schema:
17257
+ example: 20
16615
17258
  format: int32
16616
17259
  maximum: 1000
16617
17260
  type: integer
@@ -16743,19 +17386,27 @@ paths:
16743
17386
  **Service Check Query**
16744
17387
 
16745
17388
 
16746
- Example: `"check".over(tags).last(count).count_by_status()`
17389
+ Example: `"check".over(tags).last(count).by(group).count_by_status()`
16747
17390
 
16748
17391
 
16749
17392
  - **`check`** name of the check, e.g. `datadog.agent.up`
16750
17393
 
16751
17394
  - **`tags`** one or more quoted tags (comma-separated), or "*". e.g.: `.over("env:prod",
16752
- "role:db")`
17395
+ "role:db")`; **`over`** cannot be blank.
16753
17396
 
16754
17397
  - **`count`** must be at greater than or equal to your max threshold (defined
16755
17398
  in the `options`). It is limited to 100.
16756
17399
 
16757
17400
  For example, if you''ve specified to notify on 1 critical, 3 ok, and 2 warn
16758
- statuses, `count` should be 3.
17401
+ statuses, `count` should be at least 3.
17402
+
17403
+ - **`group`** must be specified for check monitors. Per-check grouping is
17404
+ already explicitly known for some service checks.
17405
+
17406
+ For example, Postgres integration monitors are tagged by `db`, `host`, and
17407
+ `port`, and Network monitors by `host`, `instance`, and `url`. See [Service
17408
+ Checks](https://docs.datadoghq.com/api/latest/service-checks/) documentation
17409
+ for more information.
16759
17410
 
16760
17411
 
16761
17412
  **Event Alert Query**
@@ -16908,6 +17559,19 @@ paths:
16908
17559
  requestBody:
16909
17560
  content:
16910
17561
  application/json:
17562
+ examples:
17563
+ json-request-body:
17564
+ value:
17565
+ message: You may need to add web hosts if this is consistently high.
17566
+ name: Bytes received on host0
17567
+ options:
17568
+ no_data_timeframe: 20
17569
+ notify_no_data: true
17570
+ query: avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100
17571
+ tags:
17572
+ - app:webserver
17573
+ - frontend
17574
+ type: metric alert
16911
17575
  schema:
16912
17576
  $ref: '#/components/schemas/Monitor'
16913
17577
  description: Create a monitor request body.
@@ -16987,6 +17651,170 @@ paths:
16987
17651
  x-menu-order: 6
16988
17652
  x-undo:
16989
17653
  type: safe
17654
+ /api/v1/monitor/groups/search:
17655
+ get:
17656
+ description: Search and filter your monitor groups details.
17657
+ operationId: SearchMonitorGroups
17658
+ parameters:
17659
+ - description: 'After entering a search query in your [Manage Monitor page][1]
17660
+ use the query parameter value in the
17661
+
17662
+ URL of the page as value for this parameter. Consult the dedicated [manage
17663
+ monitor documentation][2]
17664
+
17665
+ page to learn more.
17666
+
17667
+
17668
+ The query can contain any number of space-separated monitor attributes,
17669
+ for instance `query="type:metric status:alert"`.
17670
+
17671
+
17672
+ [1]: https://app.datadoghq.com/monitors/manage
17673
+
17674
+ [2]: /monitors/manage_monitor/#find-the-monitors'
17675
+ in: query
17676
+ name: query
17677
+ required: false
17678
+ schema:
17679
+ type: string
17680
+ - description: Page to start paginating from.
17681
+ in: query
17682
+ name: page
17683
+ required: false
17684
+ schema:
17685
+ default: 0
17686
+ format: int64
17687
+ type: integer
17688
+ - description: Number of monitors to return per page.
17689
+ in: query
17690
+ name: per_page
17691
+ required: false
17692
+ schema:
17693
+ default: 30
17694
+ format: int64
17695
+ type: integer
17696
+ - description: 'String for sort order, composed of field and sort order separate
17697
+ by a comma, e.g. `name,asc`. Supported sort directions: `asc`, `desc`. Supported
17698
+ fields:
17699
+
17700
+
17701
+ * `name`
17702
+
17703
+ * `status`
17704
+
17705
+ * `tags`'
17706
+ in: query
17707
+ name: sort
17708
+ required: false
17709
+ schema:
17710
+ type: string
17711
+ responses:
17712
+ '200':
17713
+ content:
17714
+ application/json:
17715
+ schema:
17716
+ $ref: '#/components/schemas/MonitorGroupSearchResponse'
17717
+ description: OK
17718
+ '400':
17719
+ content:
17720
+ application/json:
17721
+ schema:
17722
+ $ref: '#/components/schemas/APIErrorResponse'
17723
+ description: Bad Request
17724
+ '403':
17725
+ content:
17726
+ application/json:
17727
+ schema:
17728
+ $ref: '#/components/schemas/APIErrorResponse'
17729
+ description: Forbidden
17730
+ summary: Monitors group search
17731
+ tags:
17732
+ - Monitors
17733
+ x-menu-order: 2
17734
+ x-undo:
17735
+ type: safe
17736
+ /api/v1/monitor/search:
17737
+ get:
17738
+ description: Search and filter your monitors details.
17739
+ operationId: SearchMonitors
17740
+ parameters:
17741
+ - description: 'After entering a search query in your [Manage Monitor page][1]
17742
+ use the query parameter value in the
17743
+
17744
+ URL of the page as value for this parameter. Consult the dedicated [manage
17745
+ monitor documentation][2]
17746
+
17747
+ page to learn more.
17748
+
17749
+
17750
+ The query can contain any number of space-separated monitor attributes,
17751
+ for instance `query="type:metric status:alert"`.
17752
+
17753
+
17754
+ [1]: https://app.datadoghq.com/monitors/manage
17755
+
17756
+ [2]: /monitors/manage_monitor/#find-the-monitors'
17757
+ in: query
17758
+ name: query
17759
+ required: false
17760
+ schema:
17761
+ type: string
17762
+ - description: Page to start paginating from.
17763
+ in: query
17764
+ name: page
17765
+ required: false
17766
+ schema:
17767
+ default: 0
17768
+ format: int64
17769
+ type: integer
17770
+ - description: Number of monitors to return per page.
17771
+ in: query
17772
+ name: per_page
17773
+ required: false
17774
+ schema:
17775
+ default: 30
17776
+ format: int64
17777
+ type: integer
17778
+ - description: 'String for sort order, composed of field and sort order separate
17779
+ by a comma, e.g. `name,asc`. Supported sort directions: `asc`, `desc`. Supported
17780
+ fields:
17781
+
17782
+
17783
+ * `name`
17784
+
17785
+ * `status`
17786
+
17787
+ * `tags`'
17788
+ in: query
17789
+ name: sort
17790
+ required: false
17791
+ schema:
17792
+ type: string
17793
+ responses:
17794
+ '200':
17795
+ content:
17796
+ application/json:
17797
+ schema:
17798
+ $ref: '#/components/schemas/MonitorSearchResponse'
17799
+ description: OK
17800
+ '400':
17801
+ content:
17802
+ application/json:
17803
+ schema:
17804
+ $ref: '#/components/schemas/APIErrorResponse'
17805
+ description: Bad Request
17806
+ '403':
17807
+ content:
17808
+ application/json:
17809
+ schema:
17810
+ $ref: '#/components/schemas/APIErrorResponse'
17811
+ description: Forbidden
17812
+ summary: Monitors search
17813
+ tags:
17814
+ - Monitors
17815
+ x-menu-order: 1
17816
+ x-undo:
17817
+ type: safe
16990
17818
  /api/v1/monitor/validate:
16991
17819
  post:
16992
17820
  description: Validate the monitor provided in the request.
@@ -17003,7 +17831,8 @@ paths:
17003
17831
  content:
17004
17832
  application/json:
17005
17833
  schema:
17006
- $ref: '#/components/schemas/Monitor'
17834
+ example: {}
17835
+ type: object
17007
17836
  description: OK
17008
17837
  '400':
17009
17838
  content:
@@ -17042,6 +17871,7 @@ paths:
17042
17871
  name: force
17043
17872
  required: false
17044
17873
  schema:
17874
+ example: 'false'
17045
17875
  type: string
17046
17876
  responses:
17047
17877
  '200':
@@ -17433,6 +18263,43 @@ paths:
17433
18263
  requestBody:
17434
18264
  content:
17435
18265
  application/json:
18266
+ examples:
18267
+ json-request-body:
18268
+ value:
18269
+ data:
18270
+ attributes:
18271
+ cells:
18272
+ - attributes:
18273
+ definition:
18274
+ text: '## Some test markdown
18275
+
18276
+
18277
+ With some example content.'
18278
+ type: markdown
18279
+ type: notebook_cells
18280
+ - attributes:
18281
+ definition:
18282
+ requests:
18283
+ - display_type: line
18284
+ q: avg:system.load.1{*}
18285
+ style:
18286
+ line_type: solid
18287
+ line_width: normal
18288
+ palette: dog_classic
18289
+ show_legend: true
18290
+ type: timeseries
18291
+ yaxis:
18292
+ scale: linear
18293
+ graph_size: m
18294
+ split_by:
18295
+ keys: []
18296
+ tags: []
18297
+ time: null
18298
+ type: notebook_cells
18299
+ name: Example Notebook
18300
+ time:
18301
+ live_span: 1h
18302
+ type: notebooks
17436
18303
  schema:
17437
18304
  $ref: '#/components/schemas/NotebookCreateRequest'
17438
18305
  description: The JSON description of the notebook you want to create.
@@ -17565,6 +18432,44 @@ paths:
17565
18432
  requestBody:
17566
18433
  content:
17567
18434
  application/json:
18435
+ examples:
18436
+ json-request-body:
18437
+ value:
18438
+ data:
18439
+ attributes:
18440
+ cells:
18441
+ - attributes:
18442
+ definition:
18443
+ text: '## Some updated test markdown
18444
+
18445
+
18446
+ With some example content.'
18447
+ type: markdown
18448
+ type: notebook_cells
18449
+ - attributes:
18450
+ definition:
18451
+ requests:
18452
+ - display_type: bars
18453
+ q: avg:system.load.1{*}
18454
+ style:
18455
+ line_type: solid
18456
+ line_width: normal
18457
+ palette: warm
18458
+ show_legend: true
18459
+ type: timeseries
18460
+ yaxis:
18461
+ scale: linear
18462
+ graph_size: m
18463
+ split_by:
18464
+ keys: []
18465
+ tags: []
18466
+ time: null
18467
+ id: abcd1234
18468
+ type: notebook_cells
18469
+ name: Example Notebook
18470
+ time:
18471
+ live_span: 1h
18472
+ type: notebooks
17568
18473
  schema:
17569
18474
  $ref: '#/components/schemas/NotebookUpdateRequest'
17570
18475
  description: Update notebook request body.
@@ -17912,13 +18817,13 @@ paths:
17912
18817
  post:
17913
18818
  description: "The metrics end-point allows you to post time-series data that\
17914
18819
  \ can be graphed on Datadog\u2019s dashboards.\nThe maximum payload size is\
17915
- \ 3.2 megabytes (3200000). Compressed payloads must have a decompressed size\
17916
- \ of up to 62 megabytes (62914560).\n\nIf you\u2019re submitting metrics directly\
17917
- \ to the Datadog API without using DogStatsD, expect\n\n- 64 bits for the\
17918
- \ timestamp\n- 32 bits for the value\n- 20 bytes for the metric names\n- 50\
17919
- \ bytes for the timeseries\n- The full payload is approximately ~ 100 bytes.\
17920
- \ However, with the DogStatsD API,\ncompression is applied, which reduces\
17921
- \ the payload size."
18820
+ \ 3.2 megabytes (3200000 bytes). Compressed payloads must have a decompressed\
18821
+ \ size of less than 62 megabytes (62914560 bytes).\n\nIf you\u2019re submitting\
18822
+ \ metrics directly to the Datadog API without using DogStatsD, expect:\n\n\
18823
+ - 64 bits for the timestamp\n- 32 bits for the value\n- 20 bytes for the metric\
18824
+ \ names\n- 50 bytes for the timeseries\n- The full payload is approximately\
18825
+ \ 100 bytes. However, with the DogStatsD API,\ncompression is applied, which\
18826
+ \ reduces the payload size."
17922
18827
  operationId: SubmitMetrics
17923
18828
  requestBody:
17924
18829
  content:
@@ -18632,7 +19537,7 @@ paths:
18632
19537
  summary: Get all locations (public and private)
18633
19538
  tags:
18634
19539
  - Synthetics
18635
- x-menu-order: 22
19540
+ x-menu-order: 23
18636
19541
  x-undo:
18637
19542
  type: safe
18638
19543
  /api/v1/synthetics/private-locations:
@@ -18669,7 +19574,7 @@ paths:
18669
19574
  tags:
18670
19575
  - Synthetics
18671
19576
  x-codegen-request-body-name: body
18672
- x-menu-order: 19
19577
+ x-menu-order: 20
18673
19578
  x-undo:
18674
19579
  operationId: DeletePrivateLocation
18675
19580
  parameters:
@@ -18701,7 +19606,7 @@ paths:
18701
19606
  summary: Delete a private location
18702
19607
  tags:
18703
19608
  - Synthetics
18704
- x-menu-order: 23
19609
+ x-menu-order: 24
18705
19610
  x-undo:
18706
19611
  type: idempotent
18707
19612
  get:
@@ -18771,7 +19676,7 @@ paths:
18771
19676
  tags:
18772
19677
  - Synthetics
18773
19678
  x-codegen-request-body-name: body
18774
- x-menu-order: 20
19679
+ x-menu-order: 22
18775
19680
  x-undo:
18776
19681
  type: idempotent
18777
19682
  /api/v1/synthetics/tests:
@@ -19313,7 +20218,7 @@ paths:
19313
20218
  summary: Get a test configuration
19314
20219
  tags:
19315
20220
  - Synthetics
19316
- x-menu-order: 24
20221
+ x-menu-order: 25
19317
20222
  x-undo:
19318
20223
  type: safe
19319
20224
  /api/v1/synthetics/tests/{public_id}/results:
@@ -19475,6 +20380,28 @@ paths:
19475
20380
  x-undo:
19476
20381
  type: idempotent
19477
20382
  /api/v1/synthetics/variables:
20383
+ get:
20384
+ description: Get the list of all Synthetics global variables.
20385
+ operationId: ListGlobalVariables
20386
+ responses:
20387
+ '200':
20388
+ content:
20389
+ application/json:
20390
+ schema:
20391
+ $ref: '#/components/schemas/SyntheticsListGlobalVariablesResponse'
20392
+ description: OK
20393
+ '403':
20394
+ content:
20395
+ application/json:
20396
+ schema:
20397
+ $ref: '#/components/schemas/APIErrorResponse'
20398
+ description: Forbidden
20399
+ summary: Get all global variables
20400
+ tags:
20401
+ - Synthetics
20402
+ x-menu-order: 15
20403
+ x-undo:
20404
+ type: safe
19478
20405
  post:
19479
20406
  description: Create a Synthetics global variable.
19480
20407
  operationId: CreateGlobalVariable
@@ -19508,7 +20435,7 @@ paths:
19508
20435
  tags:
19509
20436
  - Synthetics
19510
20437
  x-codegen-request-body-name: body
19511
- x-menu-order: 15
20438
+ x-menu-order: 16
19512
20439
  x-undo:
19513
20440
  operationId: DeleteGlobalVariable
19514
20441
  parameters:
@@ -19550,7 +20477,7 @@ paths:
19550
20477
  summary: Delete a global variable
19551
20478
  tags:
19552
20479
  - Synthetics
19553
- x-menu-order: 18
20480
+ x-menu-order: 19
19554
20481
  x-undo:
19555
20482
  type: idempotent
19556
20483
  get:
@@ -19585,7 +20512,7 @@ paths:
19585
20512
  summary: Get a global variable
19586
20513
  tags:
19587
20514
  - Synthetics
19588
- x-menu-order: 17
20515
+ x-menu-order: 18
19589
20516
  x-undo:
19590
20517
  type: safe
19591
20518
  put:
@@ -19628,7 +20555,7 @@ paths:
19628
20555
  tags:
19629
20556
  - Synthetics
19630
20557
  x-codegen-request-body-name: body
19631
- x-menu-order: 16
20558
+ x-menu-order: 17
19632
20559
  x-undo:
19633
20560
  type: idempotent
19634
20561
  /api/v1/tags/hosts:
@@ -19980,6 +20907,54 @@ paths:
19980
20907
  x-unstable: '**Note**: This endpoint is in public beta.
19981
20908
 
19982
20909
  If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
20910
+ /api/v1/usage/audit_logs:
20911
+ get:
20912
+ description: Get hourly usage for audit logs.
20913
+ operationId: GetUsageAuditLogs
20914
+ parameters:
20915
+ - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`
20916
+ for usage beginning at this hour.'
20917
+ in: query
20918
+ name: start_hr
20919
+ required: true
20920
+ schema:
20921
+ format: date-time
20922
+ type: string
20923
+ - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`
20924
+ for usage ending
20925
+
20926
+ **before** this hour.'
20927
+ in: query
20928
+ name: end_hr
20929
+ required: false
20930
+ schema:
20931
+ format: date-time
20932
+ type: string
20933
+ responses:
20934
+ '200':
20935
+ content:
20936
+ application/json;datetime-format=rfc3339:
20937
+ schema:
20938
+ $ref: '#/components/schemas/UsageAuditLogsResponse'
20939
+ description: OK
20940
+ '400':
20941
+ content:
20942
+ application/json;datetime-format=rfc3339:
20943
+ schema:
20944
+ $ref: '#/components/schemas/APIErrorResponse'
20945
+ description: Bad Request
20946
+ '403':
20947
+ content:
20948
+ application/json;datetime-format=rfc3339:
20949
+ schema:
20950
+ $ref: '#/components/schemas/APIErrorResponse'
20951
+ description: Forbidden - User is not authorized
20952
+ summary: Get hourly usage for audit logs
20953
+ tags:
20954
+ - Usage Metering
20955
+ x-menu-order: 31
20956
+ x-undo:
20957
+ type: safe
19983
20958
  /api/v1/usage/aws_lambda:
19984
20959
  get:
19985
20960
  description: Get hourly usage for lambda.
@@ -20064,10 +21039,10 @@ paths:
20064
21039
  x-menu-order: 19
20065
21040
  x-undo:
20066
21041
  type: safe
20067
- /api/v1/usage/compliance-monitoring:
21042
+ /api/v1/usage/cspm:
20068
21043
  get:
20069
- description: Get hourly usage for Compliance Monitoring.
20070
- operationId: GetUsageComplianceMonitoring
21044
+ description: Get hourly usage for Cloud Security Posture Management (CSPM).
21045
+ operationId: GetUsageCloudSecurityPostureManagement
20071
21046
  parameters:
20072
21047
  - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`
20073
21048
  for usage beginning at this hour.'
@@ -20092,7 +21067,7 @@ paths:
20092
21067
  content:
20093
21068
  application/json;datetime-format=rfc3339:
20094
21069
  schema:
20095
- $ref: '#/components/schemas/UsageComplianceResponse'
21070
+ $ref: '#/components/schemas/UsageCloudSecurityPostureManagementResponse'
20096
21071
  description: OK
20097
21072
  '400':
20098
21073
  content:
@@ -20106,12 +21081,60 @@ paths:
20106
21081
  schema:
20107
21082
  $ref: '#/components/schemas/APIErrorResponse'
20108
21083
  description: Forbidden - User is not authorized
20109
- summary: Get hourly usage for Compliance Monitoring
21084
+ summary: Get hourly usage for CSPM
20110
21085
  tags:
20111
21086
  - Usage Metering
20112
21087
  x-menu-order: 30
20113
21088
  x-undo:
20114
21089
  type: safe
21090
+ /api/v1/usage/cws:
21091
+ get:
21092
+ description: Get hourly usage for Cloud Workload Security.
21093
+ operationId: GetUsageCWS
21094
+ parameters:
21095
+ - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`
21096
+ for usage beginning at this hour.'
21097
+ in: query
21098
+ name: start_hr
21099
+ required: true
21100
+ schema:
21101
+ format: date-time
21102
+ type: string
21103
+ - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`
21104
+ for usage ending
21105
+
21106
+ **before** this hour.'
21107
+ in: query
21108
+ name: end_hr
21109
+ required: false
21110
+ schema:
21111
+ format: date-time
21112
+ type: string
21113
+ responses:
21114
+ '200':
21115
+ content:
21116
+ application/json;datetime-format=rfc3339:
21117
+ schema:
21118
+ $ref: '#/components/schemas/UsageCWSResponse'
21119
+ description: OK
21120
+ '400':
21121
+ content:
21122
+ application/json;datetime-format=rfc3339:
21123
+ schema:
21124
+ $ref: '#/components/schemas/APIErrorResponse'
21125
+ description: Bad Request
21126
+ '403':
21127
+ content:
21128
+ application/json;datetime-format=rfc3339:
21129
+ schema:
21130
+ $ref: '#/components/schemas/APIErrorResponse'
21131
+ description: Forbidden - User is not authorized
21132
+ summary: Get hourly usage for Cloud Workload Security
21133
+ tags:
21134
+ - Usage Metering
21135
+ x-menu-order: 31
21136
+ x-undo:
21137
+ type: safe
20115
21138
  /api/v1/usage/fargate:
20116
21139
  get:
20117
21140
  description: Get hourly usage for [Fargate](https://docs.datadoghq.com/integrations/ecs_fargate/).
@@ -21026,7 +22049,7 @@ paths:
21026
22049
  type: safe
21027
22050
  /api/v1/usage/top_avg_metrics:
21028
22051
  get:
21029
- description: Get top [custom metrics](https://docs.datadoghq.com/developers/metrics/custom_metrics/)
22052
+ description: Get all [custom metrics](https://docs.datadoghq.com/developers/metrics/custom_metrics/)
21030
22053
  by hourly average. Use the month parameter to get a month-to-date data resolution
21031
22054
  or use the day parameter to get a daily resolution. One of the two is required,
21032
22055
  and only one of the two is allowed.
@@ -21067,6 +22090,13 @@ paths:
21067
22090
  maximum: 5000
21068
22091
  minimum: 1
21069
22092
  type: integer
22093
+ - description: List following results with a next_record_id provided in the
22094
+ previous query.
22095
+ in: query
22096
+ name: next_record_id
22097
+ required: false
22098
+ schema:
22099
+ type: string
21070
22100
  responses:
21071
22101
  '200':
21072
22102
  content:
@@ -21086,7 +22116,7 @@ paths:
21086
22116
  schema:
21087
22117
  $ref: '#/components/schemas/APIErrorResponse'
21088
22118
  description: Forbidden - User is not authorized
21089
- summary: Get top custom metrics by hourly average
22119
+ summary: Get all custom metrics by hourly average
21090
22120
  tags:
21091
22121
  - Usage Metering
21092
22122
  x-menu-order: 5
@@ -21794,6 +22824,8 @@ tags:
21794
22824
 
21795
22825
  - [Read more about Custom Check monitors.][4]
21796
22826
 
22827
+ - [Read more about Service Check and status codes.][5]
22828
+
21797
22829
 
21798
22830
  [1]: https://docs.datadoghq.com/monitors/monitor_types/host/?tab=checkalert
21799
22831
 
@@ -21801,7 +22833,9 @@ tags:
21801
22833
 
21802
22834
  [3]: https://docs.datadoghq.com/monitors/monitor_types/network/?tab=checkalert
21803
22835
 
21804
- [4]: https://docs.datadoghq.com/monitors/monitor_types/custom_check/?tab=checkalert'
22836
+ [4]: https://docs.datadoghq.com/monitors/monitor_types/custom_check/?tab=checkalert
22837
+
22838
+ [5]: https://docs.datadoghq.com/developers/service_checks/'
21805
22839
  name: Service Checks
21806
22840
  - description: "SLO Status Corrections allow you to prevent specific time periods\
21807
22841
  \ from negatively impacting\nyour SLO\u2019s status and error budget. You can\