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
data/docs/v1/Downtime.md CHANGED
@@ -5,6 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **active** | **Boolean** | If a scheduled downtime currently exists. | [optional][readonly] |
8
+ | **active_child** | [**DowntimeChild**](DowntimeChild.md) | | [optional] |
8
9
  | **canceled** | **Integer** | If a scheduled downtime is canceled. | [optional][readonly] |
9
10
  | **creator_id** | **Integer** | User ID of the downtime creator. | [optional][readonly] |
10
11
  | **disabled** | **Boolean** | If a downtime has been disabled. | [optional] |
@@ -28,6 +29,7 @@ require 'datadog_api_client/v1'
28
29
 
29
30
  instance = DatadogAPIClient::V1::Downtime.new(
30
31
  active: true,
32
+ active_child: null,
31
33
  canceled: 1412799983,
32
34
  creator_id: 123456,
33
35
  disabled: false,
@@ -0,0 +1,48 @@
1
+ # DatadogAPIClient::V1::DowntimeChild
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **active** | **Boolean** | If a scheduled downtime currently exists. | [optional][readonly] |
8
+ | **canceled** | **Integer** | If a scheduled downtime is canceled. | [optional][readonly] |
9
+ | **creator_id** | **Integer** | User ID of the downtime creator. | [optional][readonly] |
10
+ | **disabled** | **Boolean** | If a downtime has been disabled. | [optional] |
11
+ | **downtime_type** | **Integer** | `0` for a downtime applied on `*` or all, `1` when the downtime is only scoped to hosts, or `2` when the downtime is scoped to anything but hosts. | [optional][readonly] |
12
+ | **_end** | **Integer** | POSIX timestamp to end the downtime. If not provided, the downtime is in effect indefinitely until you cancel it. | [optional] |
13
+ | **id** | **Integer** | The downtime ID. | [optional][readonly] |
14
+ | **message** | **String** | A message to include with notifications for this downtime. Email notifications can be sent to specific users by using the same `@username` notation as events. | [optional] |
15
+ | **monitor_id** | **Integer** | A single monitor to which the downtime applies. If not provided, the downtime applies to all monitors. | [optional] |
16
+ | **monitor_tags** | **Array<String>** | A comma-separated list of monitor tags. For example, tags that are applied directly to monitors, not tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies. The resulting downtime applies to monitors that match ALL provided monitor tags. For example, `service:postgres` **AND** `team:frontend`. | [optional] |
17
+ | **parent_id** | **Integer** | ID of the parent Downtime. | [optional] |
18
+ | **recurrence** | [**DowntimeRecurrence**](DowntimeRecurrence.md) | | [optional] |
19
+ | **scope** | **Array<String>** | The scope(s) to which the downtime applies. For example, `host:app2`. Provide multiple scopes as a comma-separated list like `env:dev,env:prod`. The resulting downtime applies to sources that matches ALL provided scopes (`env:dev` **AND** `env:prod`). | [optional] |
20
+ | **start** | **Integer** | POSIX timestamp to start the downtime. If not provided, the downtime starts the moment it is created. | [optional] |
21
+ | **timezone** | **String** | The timezone in which to display the downtime's start and end times in Datadog applications. | [optional] |
22
+ | **updater_id** | **Integer** | ID of the last user that updated the downtime. | [optional][readonly] |
23
+
24
+ ## Example
25
+
26
+ ```ruby
27
+ require 'datadog_api_client/v1'
28
+
29
+ instance = DatadogAPIClient::V1::DowntimeChild.new(
30
+ active: true,
31
+ canceled: 1412799983,
32
+ creator_id: 123456,
33
+ disabled: false,
34
+ downtime_type: 2,
35
+ _end: 1412793983,
36
+ id: 1626,
37
+ message: Message on the downtime,
38
+ monitor_id: 123456,
39
+ monitor_tags: ["*"],
40
+ parent_id: 123,
41
+ recurrence: null,
42
+ scope: ["env:staging"],
43
+ start: 1412792983,
44
+ timezone: America/New_York,
45
+ updater_id: 123456
46
+ )
47
+ ```
48
+
@@ -276,7 +276,7 @@ end
276
276
 
277
277
  Submit metrics
278
278
 
279
- The metrics end-point allows you to post time-series data that can be graphed on Datadog’s dashboards. The maximum payload size is 3.2 megabytes (3200000). Compressed payloads must have a decompressed size of up to 62 megabytes (62914560). If you’re submitting metrics directly to the Datadog API without using DogStatsD, expect - 64 bits for the timestamp - 32 bits for the value - 20 bytes for the metric names - 50 bytes for the timeseries - The full payload is approximately ~ 100 bytes. However, with the DogStatsD API, compression is applied, which reduces the payload size.
279
+ The metrics end-point allows you to post time-series data that can be graphed on Datadog’s dashboards. The maximum payload size is 3.2 megabytes (3200000 bytes). Compressed payloads must have a decompressed size of less than 62 megabytes (62914560 bytes). If you’re submitting metrics directly to the Datadog API without using DogStatsD, expect: - 64 bits for the timestamp - 32 bits for the value - 20 bytes for the metric names - 50 bytes for the timeseries - The full payload is approximately 100 bytes. However, with the DogStatsD API, compression is applied, which reduces the payload size.
280
280
 
281
281
  ### Examples
282
282
 
data/docs/v1/Monitor.md CHANGED
@@ -15,11 +15,11 @@
15
15
  | **options** | [**MonitorOptions**](MonitorOptions.md) | | [optional] |
16
16
  | **overall_state** | [**MonitorOverallStates**](MonitorOverallStates.md) | | [optional] |
17
17
  | **priority** | **Integer** | Integer from 1 (high) to 5 (low) indicating alert severity. | [optional] |
18
- | **query** | **String** | The monitor query. | [optional] |
18
+ | **query** | **String** | The monitor query. | |
19
19
  | **restricted_roles** | **Array<String>** | A list of role identifiers that can be pulled from the Roles API. Cannot be used with `locked` option. | [optional] |
20
20
  | **state** | [**MonitorState**](MonitorState.md) | | [optional] |
21
21
  | **tags** | **Array<String>** | Tags associated to your monitor. | [optional] |
22
- | **type** | [**MonitorType**](MonitorType.md) | | [optional] |
22
+ | **type** | [**MonitorType**](MonitorType.md) | | |
23
23
 
24
24
  ## Example
25
25
 
@@ -38,7 +38,7 @@ instance = DatadogAPIClient::V1::Monitor.new(
38
38
  options: null,
39
39
  overall_state: null,
40
40
  priority: null,
41
- query: null,
41
+ query: avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100,
42
42
  restricted_roles: null,
43
43
  state: null,
44
44
  tags: null,
@@ -0,0 +1,22 @@
1
+ # DatadogAPIClient::V1::MonitorGroupSearchResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **counts** | [**MonitorGroupSearchResponseCounts**](MonitorGroupSearchResponseCounts.md) | | [optional] |
8
+ | **groups** | [**Array<MonitorGroupSearchResult>**](MonitorGroupSearchResult.md) | The list of found monitor groups. | [optional][readonly] |
9
+ | **metadata** | [**MonitorSearchResponseMetadata**](MonitorSearchResponseMetadata.md) | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'datadog_api_client/v1'
15
+
16
+ instance = DatadogAPIClient::V1::MonitorGroupSearchResponse.new(
17
+ counts: null,
18
+ groups: null,
19
+ metadata: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,20 @@
1
+ # DatadogAPIClient::V1::MonitorGroupSearchResponseCounts
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **status** | **Array<Object>** | Search facets. | [optional] |
8
+ | **type** | **Array<Object>** | Search facets. | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'datadog_api_client/v1'
14
+
15
+ instance = DatadogAPIClient::V1::MonitorGroupSearchResponseCounts.new(
16
+ status: null,
17
+ type: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,30 @@
1
+ # DatadogAPIClient::V1::MonitorGroupSearchResult
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **group** | **String** | The name of the group. | [optional][readonly] |
8
+ | **group_tags** | **Array<String>** | The list of tags of the monitor group. | [optional][readonly] |
9
+ | **last_nodata_ts** | **Integer** | Latest timestamp the monitor group was in NO_DATA state. | [optional][readonly] |
10
+ | **last_triggered_ts** | **Integer** | Latest timestamp the monitor group triggered. | [optional][readonly] |
11
+ | **monitor_id** | **Integer** | The ID of the monitor. | [optional][readonly] |
12
+ | **monitor_name** | **String** | The name of the monitor. | [optional][readonly] |
13
+ | **status** | [**MonitorOverallStates**](MonitorOverallStates.md) | | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'datadog_api_client/v1'
19
+
20
+ instance = DatadogAPIClient::V1::MonitorGroupSearchResult.new(
21
+ group: null,
22
+ group_tags: null,
23
+ last_nodata_ts: null,
24
+ last_triggered_ts: null,
25
+ monitor_id: null,
26
+ monitor_name: null,
27
+ status: null
28
+ )
29
+ ```
30
+
@@ -7,7 +7,7 @@
7
7
  | **aggregation** | [**MonitorOptionsAggregation**](MonitorOptionsAggregation.md) | | [optional] |
8
8
  | **device_ids** | [**Array<MonitorDeviceID>**](MonitorDeviceID.md) | IDs of the device the Synthetics monitor is running on. | [optional][readonly] |
9
9
  | **enable_logs_sample** | **Boolean** | Whether or not to send a log sample when the log monitor triggers. | [optional] |
10
- | **escalation_message** | **String** | A message to include with a re-notification. Supports the `@username` notification we allow elsewhere. Not applicable if `renotify_interval` is `None`. | [optional][default to 'none'] |
10
+ | **escalation_message** | **String** | We recommend using the [is_renotify](https://docs.datadoghq.com/monitors/notifications/?tab=is_alert#renotify), block in the original message instead. A message to include with a re-notification. Supports the `@username` notification we allow elsewhere. Not applicable if `renotify_interval` is `None`. | [optional][default to 'none'] |
11
11
  | **evaluation_delay** | **Integer** | Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to `300` (5min), the timeframe is set to `last_5m` and the time is 7:00, the monitor evaluates data from 6:50 to 6:55. This is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor always has data during evaluation. | [optional] |
12
12
  | **groupby_simple_monitor** | **Boolean** | Whether the log alert monitor triggers a single alert or multiple alerts when any group breaches a threshold. | [optional] |
13
13
  | **include_tags** | **Boolean** | A Boolean indicating whether notifications from this monitor automatically inserts its triggering tags into the title. **Examples** - If `True`, `[Triggered on {host:h1}] Monitor Title` - If `False`, `[Triggered] Monitor Title` | [optional][default to true] |
@@ -0,0 +1,22 @@
1
+ # DatadogAPIClient::V1::MonitorSearchResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **counts** | [**MonitorSearchResponseCounts**](MonitorSearchResponseCounts.md) | | [optional] |
8
+ | **metadata** | [**MonitorSearchResponseMetadata**](MonitorSearchResponseMetadata.md) | | [optional] |
9
+ | **monitors** | [**Array<MonitorSearchResult>**](MonitorSearchResult.md) | The list of found monitors. | [optional][readonly] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'datadog_api_client/v1'
15
+
16
+ instance = DatadogAPIClient::V1::MonitorSearchResponse.new(
17
+ counts: null,
18
+ metadata: null,
19
+ monitors: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,24 @@
1
+ # DatadogAPIClient::V1::MonitorSearchResponseCounts
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **muted** | **Array<Object>** | Search facets. | [optional] |
8
+ | **status** | **Array<Object>** | Search facets. | [optional] |
9
+ | **tag** | **Array<Object>** | Search facets. | [optional] |
10
+ | **type** | **Array<Object>** | Search facets. | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'datadog_api_client/v1'
16
+
17
+ instance = DatadogAPIClient::V1::MonitorSearchResponseCounts.new(
18
+ muted: null,
19
+ status: null,
20
+ tag: null,
21
+ type: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,24 @@
1
+ # DatadogAPIClient::V1::MonitorSearchResponseMetadata
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **page** | **Integer** | The page to start paginating from. | [optional][readonly] |
8
+ | **page_count** | **Integer** | The number of pages. | [optional][readonly] |
9
+ | **per_page** | **Integer** | The number of monitors to return per page. | [optional][readonly] |
10
+ | **total_count** | **Integer** | The total number of monitors. | [optional][readonly] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'datadog_api_client/v1'
16
+
17
+ instance = DatadogAPIClient::V1::MonitorSearchResponseMetadata.new(
18
+ page: null,
19
+ page_count: null,
20
+ per_page: null,
21
+ total_count: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,40 @@
1
+ # DatadogAPIClient::V1::MonitorSearchResult
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **classification** | **String** | Classification of the monitor. | [optional][readonly] |
8
+ | **creator** | [**Creator**](Creator.md) | | [optional] |
9
+ | **id** | **Integer** | ID of the monitor. | [optional][readonly] |
10
+ | **last_triggered_ts** | **Integer** | Latest timestamp the monitor triggered. | [optional][readonly] |
11
+ | **metrics** | **Array<String>** | Metrics used by the monitor. | [optional][readonly] |
12
+ | **name** | **String** | The monitor name. | [optional][readonly] |
13
+ | **notifications** | [**Array<MonitorSearchResultNotification>**](MonitorSearchResultNotification.md) | The notification triggered by the monitor. | [optional][readonly] |
14
+ | **org_id** | **Integer** | The ID of the organization. | [optional][readonly] |
15
+ | **scopes** | **Array<String>** | The scope(s) to which the downtime applies, e.g. `host:app2`. Provide multiple scopes as a comma-separated list, e.g. `env:dev,env:prod`. The resulting downtime applies to sources that matches ALL provided scopes (i.e. `env:dev AND env:prod`), NOT any of them. | [optional] |
16
+ | **status** | [**MonitorOverallStates**](MonitorOverallStates.md) | | [optional] |
17
+ | **tags** | **Array<String>** | Tags associated with the monitor. | [optional][readonly] |
18
+ | **type** | [**MonitorType**](MonitorType.md) | | [optional] |
19
+
20
+ ## Example
21
+
22
+ ```ruby
23
+ require 'datadog_api_client/v1'
24
+
25
+ instance = DatadogAPIClient::V1::MonitorSearchResult.new(
26
+ classification: null,
27
+ creator: null,
28
+ id: null,
29
+ last_triggered_ts: null,
30
+ metrics: null,
31
+ name: null,
32
+ notifications: null,
33
+ org_id: null,
34
+ scopes: ["host:app2","env:dev,env:prod"],
35
+ status: null,
36
+ tags: null,
37
+ type: null
38
+ )
39
+ ```
40
+
@@ -0,0 +1,20 @@
1
+ # DatadogAPIClient::V1::MonitorSearchResultNotification
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **handle** | **String** | The email address that received the notification. | [optional][readonly] |
8
+ | **name** | **String** | The username receiving the notification | [optional][readonly] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'datadog_api_client/v1'
14
+
15
+ instance = DatadogAPIClient::V1::MonitorSearchResultNotification.new(
16
+ handle: null,
17
+ name: null
18
+ )
19
+ ```
20
+
@@ -9,6 +9,8 @@ All URIs are relative to *https://api.datadoghq.com*
9
9
  | [**delete_monitor**](MonitorsAPI.md#delete_monitor) | **DELETE** /api/v1/monitor/{monitor_id} | Delete a monitor |
10
10
  | [**get_monitor**](MonitorsAPI.md#get_monitor) | **GET** /api/v1/monitor/{monitor_id} | Get a monitor's details |
11
11
  | [**list_monitors**](MonitorsAPI.md#list_monitors) | **GET** /api/v1/monitor | Get all monitor details |
12
+ | [**search_monitor_groups**](MonitorsAPI.md#search_monitor_groups) | **GET** /api/v1/monitor/groups/search | Monitors group search |
13
+ | [**search_monitors**](MonitorsAPI.md#search_monitors) | **GET** /api/v1/monitor/search | Monitors search |
12
14
  | [**update_monitor**](MonitorsAPI.md#update_monitor) | **PUT** /api/v1/monitor/{monitor_id} | Edit a monitor |
13
15
  | [**validate_monitor**](MonitorsAPI.md#validate_monitor) | **POST** /api/v1/monitor/validate | Validate a monitor |
14
16
 
@@ -81,14 +83,14 @@ end
81
83
 
82
84
  Create a monitor
83
85
 
84
- Create a monitor using the specified options. #### Monitor Types The type of monitor chosen from: - anomaly: `query alert` - APM: `query alert` or `trace-analytics alert` - composite: `composite` - custom: `service check` - event: `event alert` - forecast: `query alert` - host: `service check` - integration: `query alert` or `service check` - live process: `process alert` - logs: `log alert` - metric: `metric alert` - network: `service check` - outlier: `query alert` - process: `service check` - rum: `rum alert` - SLO: `slo alert` - watchdog: `event alert` - event-v2: `event-v2 alert` #### Query Types **Metric Alert Query** Example: `time_aggr(time_window):space_aggr:metric{tags} [by {key}] operator #` - `time_aggr`: avg, sum, max, min, change, or pct_change - `time_window`: `last_#m` (with `#` between 1 and 2880 depending on the monitor type) or `last_#h`(with `#` between 1 and 48 depending on the monitor type), or `last_1d` - `space_aggr`: avg, sum, min, or max - `tags`: one or more tags (comma-separated), or * - `key`: a 'key' in key:value tag syntax; defines a separate alert for each tag in the group (multi-alert) - `operator`: <, <=, >, >=, ==, or != - `#`: an integer or decimal number used to set the threshold If you are using the `_change_` or `_pct_change_` time aggregator, instead use `change_aggr(time_aggr(time_window), timeshift):space_aggr:metric{tags} [by {key}] operator #` with: - `change_aggr` change, pct_change - `time_aggr` avg, sum, max, min [Learn more](https://docs.datadoghq.com/monitors/monitor_types/#define-the-conditions) - `time_window` last\\_#m (between 1 and 2880 depending on the monitor type), last\\_#h (between 1 and 48 depending on the monitor type), or last_#d (1 or 2) - `timeshift` #m_ago (5, 10, 15, or 30), #h_ago (1, 2, or 4), or 1d_ago Use this to create an outlier monitor using the following query: `avg(last_30m):outliers(avg:system.cpu.user{role:es-events-data} by {host}, 'dbscan', 7) > 0` **Service Check Query** Example: `\"check\".over(tags).last(count).count_by_status()` - **`check`** name of the check, e.g. `datadog.agent.up` - **`tags`** one or more quoted tags (comma-separated), or \"*\". e.g.: `.over(\"env:prod\", \"role:db\")` - **`count`** must be at greater than or equal to your max threshold (defined in the `options`). It is limited to 100. For example, if you've specified to notify on 1 critical, 3 ok, and 2 warn statuses, `count` should be 3. **Event Alert Query** Example: `events('sources:nagios status:error,warning priority:normal tags: \"string query\"').rollup(\"count\").last(\"1h\")\"` - **`event`**, the event query string: - **`string_query`** free text query to match against event title and text. - **`sources`** event sources (comma-separated). - **`status`** event statuses (comma-separated). Valid options: error, warn, and info. - **`priority`** event priorities (comma-separated). Valid options: low, normal, all. - **`host`** event reporting host (comma-separated). - **`tags`** event tags (comma-separated). - **`excluded_tags`** excluded event tags (comma-separated). - **`rollup`** the stats roll-up method. `count` is the only supported method now. - **`last`** the timeframe to roll up the counts. Examples: 45m, 4h. Supported timeframes: m, h and d. This value should not exceed 48 hours. **NOTE** Only available on US1 and EU. **Event V2 Alert Query** Example: `events(query).rollup(rollup_method[, measure]).last(time_window) operator #` - **`query`** The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/). - **`rollup_method`** The stats roll-up method - supports `count`, `avg` and `cardinality`. - **`measure`** For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use. - **`time_window`** #m (5, 10, 15, or 30), #h (1, 2, or 4, 24). - **`operator`** `<`, `<=`, `>`, `>=`, `==`, or `!=`. - **`#`** an integer or decimal number used to set the threshold. **NOTE** Only available on US1-FED, US3, and in closed beta on EU and US1. **Process Alert Query** Example: `processes(search).over(tags).rollup('count').last(timeframe) operator #` - **`search`** free text search string for querying processes. Matching processes match results on the [Live Processes](https://docs.datadoghq.com/infrastructure/process/?tab=linuxwindows) page. - **`tags`** one or more tags (comma-separated) - **`timeframe`** the timeframe to roll up the counts. Examples: 10m, 4h. Supported timeframes: s, m, h and d - **`operator`** <, <=, >, >=, ==, or != - **`#`** an integer or decimal number used to set the threshold **Logs Alert Query** Example: `logs(query).index(index_name).rollup(rollup_method[, measure]).last(time_window) operator #` - **`query`** The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/). - **`index_name`** For multi-index organizations, the log index in which the request is performed. - **`rollup_method`** The stats roll-up method - supports `count`, `avg` and `cardinality`. - **`measure`** For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use. - **`time_window`** #m (between 1 and 2880), #h (between 1 and 48) - **`operator`** `<`, `<=`, `>`, `>=`, `==`, or `!=`. - **`#`** an integer or decimal number used to set the threshold. **Composite Query** Example: `12345 && 67890`, where `12345` and `67890` are the IDs of non-composite monitors * **`name`** [*required*, *default* = **dynamic, based on query**]: The name of the alert. * **`message`** [*required*, *default* = **dynamic, based on query**]: A message to include with notifications for this monitor. Email notifications can be sent to specific users by using the same '@username' notation as events. * **`tags`** [*optional*, *default* = **empty list**]: A list of tags to associate with your monitor. When getting all monitor details via the API, use the `monitor_tags` argument to filter results by these tags. It is only available via the API and isn't visible or editable in the Datadog UI. **SLO Alert Query** Example: `error_budget(\"slo_id\").over(\"time_window\") operator #` - **`slo_id`**: The alphanumeric SLO ID of the SLO you are configuring the alert for. - **`time_window`**: The time window of the SLO target you wish to alert on. Valid options: `7d`, `30d`, `90d`. - **`operator`**: `>=` or `>`
86
+ Create a monitor using the specified options. #### Monitor Types The type of monitor chosen from: - anomaly: `query alert` - APM: `query alert` or `trace-analytics alert` - composite: `composite` - custom: `service check` - event: `event alert` - forecast: `query alert` - host: `service check` - integration: `query alert` or `service check` - live process: `process alert` - logs: `log alert` - metric: `metric alert` - network: `service check` - outlier: `query alert` - process: `service check` - rum: `rum alert` - SLO: `slo alert` - watchdog: `event alert` - event-v2: `event-v2 alert` #### Query Types **Metric Alert Query** Example: `time_aggr(time_window):space_aggr:metric{tags} [by {key}] operator #` - `time_aggr`: avg, sum, max, min, change, or pct_change - `time_window`: `last_#m` (with `#` between 1 and 2880 depending on the monitor type) or `last_#h`(with `#` between 1 and 48 depending on the monitor type), or `last_1d` - `space_aggr`: avg, sum, min, or max - `tags`: one or more tags (comma-separated), or * - `key`: a 'key' in key:value tag syntax; defines a separate alert for each tag in the group (multi-alert) - `operator`: <, <=, >, >=, ==, or != - `#`: an integer or decimal number used to set the threshold If you are using the `_change_` or `_pct_change_` time aggregator, instead use `change_aggr(time_aggr(time_window), timeshift):space_aggr:metric{tags} [by {key}] operator #` with: - `change_aggr` change, pct_change - `time_aggr` avg, sum, max, min [Learn more](https://docs.datadoghq.com/monitors/monitor_types/#define-the-conditions) - `time_window` last\\_#m (between 1 and 2880 depending on the monitor type), last\\_#h (between 1 and 48 depending on the monitor type), or last_#d (1 or 2) - `timeshift` #m_ago (5, 10, 15, or 30), #h_ago (1, 2, or 4), or 1d_ago Use this to create an outlier monitor using the following query: `avg(last_30m):outliers(avg:system.cpu.user{role:es-events-data} by {host}, 'dbscan', 7) > 0` **Service Check Query** Example: `\"check\".over(tags).last(count).by(group).count_by_status()` - **`check`** name of the check, e.g. `datadog.agent.up` - **`tags`** one or more quoted tags (comma-separated), or \"*\". e.g.: `.over(\"env:prod\", \"role:db\")`; **`over`** cannot be blank. - **`count`** must be at greater than or equal to your max threshold (defined in the `options`). It is limited to 100. For example, if you've specified to notify on 1 critical, 3 ok, and 2 warn statuses, `count` should be at least 3. - **`group`** must be specified for check monitors. Per-check grouping is already explicitly known for some service checks. For example, Postgres integration monitors are tagged by `db`, `host`, and `port`, and Network monitors by `host`, `instance`, and `url`. See [Service Checks](https://docs.datadoghq.com/api/latest/service-checks/) documentation for more information. **Event Alert Query** Example: `events('sources:nagios status:error,warning priority:normal tags: \"string query\"').rollup(\"count\").last(\"1h\")\"` - **`event`**, the event query string: - **`string_query`** free text query to match against event title and text. - **`sources`** event sources (comma-separated). - **`status`** event statuses (comma-separated). Valid options: error, warn, and info. - **`priority`** event priorities (comma-separated). Valid options: low, normal, all. - **`host`** event reporting host (comma-separated). - **`tags`** event tags (comma-separated). - **`excluded_tags`** excluded event tags (comma-separated). - **`rollup`** the stats roll-up method. `count` is the only supported method now. - **`last`** the timeframe to roll up the counts. Examples: 45m, 4h. Supported timeframes: m, h and d. This value should not exceed 48 hours. **NOTE** Only available on US1 and EU. **Event V2 Alert Query** Example: `events(query).rollup(rollup_method[, measure]).last(time_window) operator #` - **`query`** The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/). - **`rollup_method`** The stats roll-up method - supports `count`, `avg` and `cardinality`. - **`measure`** For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use. - **`time_window`** #m (5, 10, 15, or 30), #h (1, 2, or 4, 24). - **`operator`** `<`, `<=`, `>`, `>=`, `==`, or `!=`. - **`#`** an integer or decimal number used to set the threshold. **NOTE** Only available on US1-FED, US3, and in closed beta on EU and US1. **Process Alert Query** Example: `processes(search).over(tags).rollup('count').last(timeframe) operator #` - **`search`** free text search string for querying processes. Matching processes match results on the [Live Processes](https://docs.datadoghq.com/infrastructure/process/?tab=linuxwindows) page. - **`tags`** one or more tags (comma-separated) - **`timeframe`** the timeframe to roll up the counts. Examples: 10m, 4h. Supported timeframes: s, m, h and d - **`operator`** <, <=, >, >=, ==, or != - **`#`** an integer or decimal number used to set the threshold **Logs Alert Query** Example: `logs(query).index(index_name).rollup(rollup_method[, measure]).last(time_window) operator #` - **`query`** The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/). - **`index_name`** For multi-index organizations, the log index in which the request is performed. - **`rollup_method`** The stats roll-up method - supports `count`, `avg` and `cardinality`. - **`measure`** For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use. - **`time_window`** #m (between 1 and 2880), #h (between 1 and 48) - **`operator`** `<`, `<=`, `>`, `>=`, `==`, or `!=`. - **`#`** an integer or decimal number used to set the threshold. **Composite Query** Example: `12345 && 67890`, where `12345` and `67890` are the IDs of non-composite monitors * **`name`** [*required*, *default* = **dynamic, based on query**]: The name of the alert. * **`message`** [*required*, *default* = **dynamic, based on query**]: A message to include with notifications for this monitor. Email notifications can be sent to specific users by using the same '@username' notation as events. * **`tags`** [*optional*, *default* = **empty list**]: A list of tags to associate with your monitor. When getting all monitor details via the API, use the `monitor_tags` argument to filter results by these tags. It is only available via the API and isn't visible or editable in the Datadog UI. **SLO Alert Query** Example: `error_budget(\"slo_id\").over(\"time_window\") operator #` - **`slo_id`**: The alphanumeric SLO ID of the SLO you are configuring the alert for. - **`time_window`**: The time window of the SLO target you wish to alert on. Valid options: `7d`, `30d`, `90d`. - **`operator`**: `>=` or `>`
85
87
 
86
88
  ### Examples
87
89
 
88
90
  ```ruby
89
91
  require 'datadog_api_client'
90
92
  api_instance = DatadogAPIClient::V1::MonitorsAPI.new
91
- body = DatadogAPIClient::V1::Monitor.new # Monitor | Create a monitor request body.
93
+ body = DatadogAPIClient::V1::Monitor.new({query: 'avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100', type: DatadogAPIClient::V1::MonitorType::COMPOSITE}) # Monitor | Create a monitor request body.
92
94
 
93
95
  begin
94
96
  # Create a monitor
@@ -152,7 +154,7 @@ require 'datadog_api_client'
152
154
  api_instance = DatadogAPIClient::V1::MonitorsAPI.new
153
155
  monitor_id = 789 # Integer | The ID of the monitor.
154
156
  opts = {
155
- force: 'force_example' # String | Delete the monitor even if it's referenced by other resources (e.g. SLO, composite monitor).
157
+ force: 'false' # String | Delete the monitor even if it's referenced by other resources (e.g. SLO, composite monitor).
156
158
  }
157
159
 
158
160
  begin
@@ -283,14 +285,14 @@ Get details about the specified monitor from your organization.
283
285
  require 'datadog_api_client'
284
286
  api_instance = DatadogAPIClient::V1::MonitorsAPI.new
285
287
  opts = {
286
- group_states: 'group_states_example', # String | When specified, shows additional information about the group states. Choose one or more from `all`, `alert`, `warn`, and `no data`.
288
+ group_states: 'alert', # String | When specified, shows additional information about the group states. Choose one or more from `all`, `alert`, `warn`, and `no data`.
287
289
  name: 'name_example', # String | A string to filter monitors by name.
288
- tags: 'tags_example', # String | A comma separated list indicating what tags, if any, should be used to filter the list of monitors by scope. For example, `host:host0`.
289
- monitor_tags: 'monitor_tags_example', # String | A comma separated list indicating what service and/or custom tags, if any, should be used to filter the list of monitors. Tags created in the Datadog UI automatically have the service key prepended. For example, `service:my-app`.
290
+ tags: 'host:host0', # String | A comma separated list indicating what tags, if any, should be used to filter the list of monitors by scope. For example, `host:host0`.
291
+ monitor_tags: 'service:my-app', # String | A comma separated list indicating what service and/or custom tags, if any, should be used to filter the list of monitors. Tags created in the Datadog UI automatically have the service key prepended. For example, `service:my-app`.
290
292
  with_downtimes: true, # Boolean | If this argument is set to true, then the returned data includes all current downtimes for each monitor.
291
293
  id_offset: 789, # Integer | Monitor ID offset.
292
- page: 789, # Integer | The page to start paginating from. If this argument is not specified, the request returns all monitors without pagination.
293
- page_size: 56 # Integer | The number of monitors to return per page. If the page argument is not specified, the default behavior returns all monitors without a `page_size` limit. However, if page is specified and `page_size` is not, the argument defaults to 100.
294
+ page: 0, # Integer | The page to start paginating from. If this argument is not specified, the request returns all monitors without pagination.
295
+ page_size: 20 # Integer | The number of monitors to return per page. If the page argument is not specified, the default behavior returns all monitors without a `page_size` limit. However, if page is specified and `page_size` is not, the argument defaults to 100.
294
296
  }
295
297
 
296
298
  begin
@@ -347,6 +349,146 @@ end
347
349
  - **Accept**: application/json
348
350
 
349
351
 
352
+ ## search_monitor_groups
353
+
354
+ > <MonitorGroupSearchResponse> search_monitor_groups(opts)
355
+
356
+ Monitors group search
357
+
358
+ Search and filter your monitor groups details.
359
+
360
+ ### Examples
361
+
362
+ ```ruby
363
+ require 'datadog_api_client'
364
+ api_instance = DatadogAPIClient::V1::MonitorsAPI.new
365
+ opts = {
366
+ query: 'query_example', # String | After entering a search query in your [Manage Monitor page][1] use the query parameter value in the URL of the page as value for this parameter. Consult the dedicated [manage monitor documentation][2] page to learn more. The query can contain any number of space-separated monitor attributes, for instance `query=\"type:metric status:alert\"`. [1]: https://app.datadoghq.com/monitors/manage [2]: /monitors/manage_monitor/#find-the-monitors
367
+ page: 789, # Integer | Page to start paginating from.
368
+ per_page: 789, # Integer | Number of monitors to return per page.
369
+ sort: 'sort_example' # String | String for sort order, composed of field and sort order separate by a comma, e.g. `name,asc`. Supported sort directions: `asc`, `desc`. Supported fields: * `name` * `status` * `tags`
370
+ }
371
+
372
+ begin
373
+ # Monitors group search
374
+ result = api_instance.search_monitor_groups(opts)
375
+ p result
376
+ rescue DatadogAPIClient::V1::APIError => e
377
+ puts "Error when calling MonitorsAPI->search_monitor_groups: #{e}"
378
+ end
379
+ ```
380
+
381
+ #### Using the search_monitor_groups_with_http_info variant
382
+
383
+ This returns an Array which contains the response data, status code and headers.
384
+
385
+ > <Array(<MonitorGroupSearchResponse>, Integer, Hash)> search_monitor_groups_with_http_info(opts)
386
+
387
+ ```ruby
388
+ begin
389
+ # Monitors group search
390
+ data, status_code, headers = api_instance.search_monitor_groups_with_http_info(opts)
391
+ p status_code # => 2xx
392
+ p headers # => { ... }
393
+ p data # => <MonitorGroupSearchResponse>
394
+ rescue DatadogAPIClient::V1::APIError => e
395
+ puts "Error when calling MonitorsAPI->search_monitor_groups_with_http_info: #{e}"
396
+ end
397
+ ```
398
+
399
+ ### Parameters
400
+
401
+ | Name | Type | Description | Notes |
402
+ | ---- | ---- | ----------- | ----- |
403
+ | **query** | **String** | After entering a search query in your [Manage Monitor page][1] use the query parameter value in the URL of the page as value for this parameter. Consult the dedicated [manage monitor documentation][2] page to learn more. The query can contain any number of space-separated monitor attributes, for instance &#x60;query&#x3D;\&quot;type:metric status:alert\&quot;&#x60;. [1]: https://app.datadoghq.com/monitors/manage [2]: /monitors/manage_monitor/#find-the-monitors | [optional] |
404
+ | **page** | **Integer** | Page to start paginating from. | [optional][default to 0] |
405
+ | **per_page** | **Integer** | Number of monitors to return per page. | [optional][default to 30] |
406
+ | **sort** | **String** | String for sort order, composed of field and sort order separate by a comma, e.g. &#x60;name,asc&#x60;. Supported sort directions: &#x60;asc&#x60;, &#x60;desc&#x60;. Supported fields: * &#x60;name&#x60; * &#x60;status&#x60; * &#x60;tags&#x60; | [optional] |
407
+
408
+ ### Return type
409
+
410
+ [**MonitorGroupSearchResponse**](MonitorGroupSearchResponse.md)
411
+
412
+ ### Authorization
413
+
414
+ [apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
415
+
416
+ ### HTTP request headers
417
+
418
+ - **Content-Type**: Not defined
419
+ - **Accept**: application/json
420
+
421
+
422
+ ## search_monitors
423
+
424
+ > <MonitorSearchResponse> search_monitors(opts)
425
+
426
+ Monitors search
427
+
428
+ Search and filter your monitors details.
429
+
430
+ ### Examples
431
+
432
+ ```ruby
433
+ require 'datadog_api_client'
434
+ api_instance = DatadogAPIClient::V1::MonitorsAPI.new
435
+ opts = {
436
+ query: 'query_example', # String | After entering a search query in your [Manage Monitor page][1] use the query parameter value in the URL of the page as value for this parameter. Consult the dedicated [manage monitor documentation][2] page to learn more. The query can contain any number of space-separated monitor attributes, for instance `query=\"type:metric status:alert\"`. [1]: https://app.datadoghq.com/monitors/manage [2]: /monitors/manage_monitor/#find-the-monitors
437
+ page: 789, # Integer | Page to start paginating from.
438
+ per_page: 789, # Integer | Number of monitors to return per page.
439
+ sort: 'sort_example' # String | String for sort order, composed of field and sort order separate by a comma, e.g. `name,asc`. Supported sort directions: `asc`, `desc`. Supported fields: * `name` * `status` * `tags`
440
+ }
441
+
442
+ begin
443
+ # Monitors search
444
+ result = api_instance.search_monitors(opts)
445
+ p result
446
+ rescue DatadogAPIClient::V1::APIError => e
447
+ puts "Error when calling MonitorsAPI->search_monitors: #{e}"
448
+ end
449
+ ```
450
+
451
+ #### Using the search_monitors_with_http_info variant
452
+
453
+ This returns an Array which contains the response data, status code and headers.
454
+
455
+ > <Array(<MonitorSearchResponse>, Integer, Hash)> search_monitors_with_http_info(opts)
456
+
457
+ ```ruby
458
+ begin
459
+ # Monitors search
460
+ data, status_code, headers = api_instance.search_monitors_with_http_info(opts)
461
+ p status_code # => 2xx
462
+ p headers # => { ... }
463
+ p data # => <MonitorSearchResponse>
464
+ rescue DatadogAPIClient::V1::APIError => e
465
+ puts "Error when calling MonitorsAPI->search_monitors_with_http_info: #{e}"
466
+ end
467
+ ```
468
+
469
+ ### Parameters
470
+
471
+ | Name | Type | Description | Notes |
472
+ | ---- | ---- | ----------- | ----- |
473
+ | **query** | **String** | After entering a search query in your [Manage Monitor page][1] use the query parameter value in the URL of the page as value for this parameter. Consult the dedicated [manage monitor documentation][2] page to learn more. The query can contain any number of space-separated monitor attributes, for instance &#x60;query&#x3D;\&quot;type:metric status:alert\&quot;&#x60;. [1]: https://app.datadoghq.com/monitors/manage [2]: /monitors/manage_monitor/#find-the-monitors | [optional] |
474
+ | **page** | **Integer** | Page to start paginating from. | [optional][default to 0] |
475
+ | **per_page** | **Integer** | Number of monitors to return per page. | [optional][default to 30] |
476
+ | **sort** | **String** | String for sort order, composed of field and sort order separate by a comma, e.g. &#x60;name,asc&#x60;. Supported sort directions: &#x60;asc&#x60;, &#x60;desc&#x60;. Supported fields: * &#x60;name&#x60; * &#x60;status&#x60; * &#x60;tags&#x60; | [optional] |
477
+
478
+ ### Return type
479
+
480
+ [**MonitorSearchResponse**](MonitorSearchResponse.md)
481
+
482
+ ### Authorization
483
+
484
+ [apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
485
+
486
+ ### HTTP request headers
487
+
488
+ - **Content-Type**: Not defined
489
+ - **Accept**: application/json
490
+
491
+
350
492
  ## update_monitor
351
493
 
352
494
  > <Monitor> update_monitor(monitor_id, body)
@@ -413,7 +555,7 @@ end
413
555
 
414
556
  ## validate_monitor
415
557
 
416
- > <Monitor> validate_monitor(body)
558
+ > Object validate_monitor(body)
417
559
 
418
560
  Validate a monitor
419
561
 
@@ -424,7 +566,7 @@ Validate the monitor provided in the request.
424
566
  ```ruby
425
567
  require 'datadog_api_client'
426
568
  api_instance = DatadogAPIClient::V1::MonitorsAPI.new
427
- body = DatadogAPIClient::V1::Monitor.new # Monitor | Monitor request object
569
+ body = DatadogAPIClient::V1::Monitor.new({query: 'avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100', type: DatadogAPIClient::V1::MonitorType::COMPOSITE}) # Monitor | Monitor request object
428
570
 
429
571
  begin
430
572
  # Validate a monitor
@@ -439,7 +581,7 @@ end
439
581
 
440
582
  This returns an Array which contains the response data, status code and headers.
441
583
 
442
- > <Array(<Monitor>, Integer, Hash)> validate_monitor_with_http_info(body)
584
+ > <Array(Object, Integer, Hash)> validate_monitor_with_http_info(body)
443
585
 
444
586
  ```ruby
445
587
  begin
@@ -447,7 +589,7 @@ begin
447
589
  data, status_code, headers = api_instance.validate_monitor_with_http_info(body)
448
590
  p status_code # => 2xx
449
591
  p headers # => { ... }
450
- p data # => <Monitor>
592
+ p data # => Object
451
593
  rescue DatadogAPIClient::V1::APIError => e
452
594
  puts "Error when calling MonitorsAPI->validate_monitor_with_http_info: #{e}"
453
595
  end
@@ -461,7 +603,7 @@ end
461
603
 
462
604
  ### Return type
463
605
 
464
- [**Monitor**](Monitor.md)
606
+ **Object**
465
607
 
466
608
  ### Authorization
467
609