datadog_api_client 2.0.2 → 2.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (192) hide show
  1. checksums.yaml +4 -4
  2. data/.apigentools-info +6 -6
  3. data/.generator/poetry.lock +21 -14
  4. data/.generator/pyproject.toml +1 -1
  5. data/.generator/schemas/v1/openapi.yaml +840 -908
  6. data/.generator/schemas/v2/openapi.yaml +1304 -913
  7. data/.generator/src/generator/formatter.py +1 -1
  8. data/.generator/src/generator/templates/api_client.j2 +5 -1
  9. data/.generator/src/generator/templates/configuration.j2 +17 -0
  10. data/.github/workflows/test.yml +4 -1
  11. data/.github/workflows/test_integration.yml +5 -0
  12. data/.pre-commit-config.yaml +1 -1
  13. data/CHANGELOG.md +49 -0
  14. data/README.md +11 -0
  15. data/examples/v1/dashboards/CreateDashboard_1094917386.rb +37 -0
  16. data/examples/v1/dashboards/CreateDashboard_1307120899.rb +61 -0
  17. data/examples/v1/dashboards/CreateDashboard_1423904722.rb +38 -0
  18. data/examples/v1/dashboards/CreateDashboard_2652180930.rb +43 -0
  19. data/examples/v1/dashboards/CreateDashboard_2850365602.rb +55 -0
  20. data/examples/v1/dashboards/CreateDashboard_3117424216.rb +33 -0
  21. data/examples/v1/dashboards/CreateDashboard_3669695268.rb +50 -0
  22. data/examples/v1/dashboards/CreateDashboard_858397694.rb +41 -0
  23. data/examples/v1/monitors/ValidateExistingMonitor.rb +1 -0
  24. data/examples/v1/monitors/ValidateMonitor.rb +1 -0
  25. data/examples/v1/monitors/ValidateMonitor_4247196452.rb +38 -0
  26. data/examples/v1/synthetics/CreateGlobalVariable.rb +1 -0
  27. data/examples/v1/synthetics/CreateGlobalVariable_1068962881.rb +23 -0
  28. data/examples/v1/synthetics/CreateSyntheticsAPITest_1279271422.rb +10 -0
  29. data/examples/v1/synthetics/CreateSyntheticsBrowserTest_2932742688.rb +6 -0
  30. data/examples/v1/synthetics/EditGlobalVariable.rb +1 -0
  31. data/examples/v1/synthetics/UpdateBrowserTest.rb +1 -0
  32. data/examples/v1/usage-metering/GetDailyCustomReports.rb +0 -3
  33. data/examples/v1/usage-metering/GetMonthlyCustomReports.rb +0 -3
  34. data/examples/v1/usage-metering/GetSpecifiedDailyCustomReports.rb +0 -3
  35. data/examples/v1/usage-metering/GetSpecifiedMonthlyCustomReports.rb +0 -3
  36. data/examples/v1/usage-metering/GetUsageAttribution.rb +0 -3
  37. data/examples/v2/incidents/ListIncidentAttachments.rb +8 -0
  38. data/examples/v2/incidents/ListIncidentAttachments_2457735435.rb +11 -0
  39. data/examples/v2/incidents/UpdateIncidentAttachments.rb +38 -0
  40. data/examples/v2/incidents/UpdateIncidentAttachments_3881702075.rb +26 -0
  41. data/examples/v2/metrics/ListActiveMetricConfigurations.rb +5 -0
  42. data/examples/v2/metrics/ListTagConfigurations.rb +1 -1
  43. data/examples/v2/metrics/ListTagConfigurations_265033704.rb +8 -0
  44. data/examples/v2/metrics/{ListTagConfigurations_103226315.rb → ListTagConfigurations_2739018321.rb} +1 -1
  45. data/examples/v2/metrics/SubmitMetrics_1762007427.rb +23 -0
  46. data/examples/v2/roles/UpdateRole.rb +13 -0
  47. data/examples/v2/rum/CreateRUMApplication.rb +15 -0
  48. data/examples/v2/rum/DeleteRUMApplication.rb +8 -0
  49. data/examples/v2/rum/GetRUMApplication.rb +8 -0
  50. data/examples/v2/rum/GetRUMApplications.rb +5 -0
  51. data/examples/v2/rum/UpdateRUMApplication.rb +16 -0
  52. data/examples/v2/security-monitoring/CreateSecurityMonitoringRule.rb +3 -2
  53. data/examples/v2/security-monitoring/CreateSecurityMonitoringRule_461183901.rb +2 -2
  54. data/examples/v2/security-monitoring/CreateSecurityMonitoringRule_498211763.rb +2 -2
  55. data/examples/v2/security-monitoring/CreateSecurityMonitoringRule_914562040.rb +50 -0
  56. data/examples/v2/security-monitoring/GetSecurityMonitoringSignal.rb +5 -0
  57. data/examples/v2/security-monitoring/UpdateSecurityMonitoringRule.rb +2 -1
  58. data/examples/v2/usage-metering/GetEstimatedCostByOrg.rb +1 -4
  59. data/examples/v2/usage-metering/GetEstimatedCostByOrg_2734954020.rb +2 -4
  60. data/examples/v2/usage-metering/GetEstimatedCostByOrg_3186693804.rb +2 -4
  61. data/examples/v2/usage-metering/GetHistoricalCostByOrg.rb +8 -0
  62. data/examples/v2/usage-metering/GetHourlyUsage.rb +5 -0
  63. data/generate.sh +30 -0
  64. data/lib/datadog_api_client/api_client.rb +5 -1
  65. data/lib/datadog_api_client/configuration.rb +20 -6
  66. data/lib/datadog_api_client/inflector.rb +67 -1
  67. data/lib/datadog_api_client/v1/api/metrics_api.rb +1 -1
  68. data/lib/datadog_api_client/v1/api/service_level_objectives_api.rb +3 -1
  69. data/lib/datadog_api_client/v1/api/usage_metering_api.rb +42 -62
  70. data/lib/datadog_api_client/v1/models/dashboard_template_variable.rb +14 -2
  71. data/lib/datadog_api_client/v1/models/dashboard_template_variable_preset_value.rb +28 -5
  72. data/lib/datadog_api_client/v1/models/formula_and_function_event_query_definition.rb +14 -4
  73. data/lib/datadog_api_client/v1/models/formula_and_function_events_data_source.rb +1 -0
  74. data/lib/datadog_api_client/v1/models/hourly_usage_attribution_usage_type.rb +2 -0
  75. data/lib/datadog_api_client/v1/models/list_stream_query.rb +14 -4
  76. data/lib/datadog_api_client/v1/models/list_stream_source.rb +1 -0
  77. data/lib/datadog_api_client/v1/models/metric_content_encoding.rb +1 -0
  78. data/lib/datadog_api_client/v1/models/monitor_options.rb +28 -1
  79. data/lib/datadog_api_client/v1/models/monitor_summary_widget_definition.rb +13 -1
  80. data/lib/datadog_api_client/v1/models/monthly_usage_attribution_supported_metrics.rb +4 -0
  81. data/lib/datadog_api_client/v1/models/monthly_usage_attribution_values.rb +41 -1
  82. data/lib/datadog_api_client/v1/models/on_missing_data_option.rb +33 -0
  83. data/lib/datadog_api_client/v1/models/search_service_level_objective.rb +111 -0
  84. data/lib/datadog_api_client/v1/models/search_service_level_objective_attributes.rb +286 -0
  85. data/lib/datadog_api_client/v1/models/search_service_level_objective_data.rb +134 -0
  86. data/lib/datadog_api_client/v1/models/search_slo_query.rb +137 -0
  87. data/lib/datadog_api_client/v1/models/search_slo_response_data_attributes.rb +8 -8
  88. data/lib/datadog_api_client/v1/models/search_slo_response_links.rb +2 -0
  89. data/lib/datadog_api_client/v1/models/search_slo_threshold.rb +184 -0
  90. data/lib/datadog_api_client/v1/models/search_slo_timeframe.rb +28 -0
  91. data/lib/datadog_api_client/v1/models/slo_creator.rb +131 -0
  92. data/lib/datadog_api_client/v1/models/slo_list_widget_definition.rb +185 -0
  93. data/lib/datadog_api_client/v1/models/slo_list_widget_definition_type.rb +26 -0
  94. data/lib/datadog_api_client/v1/models/slo_list_widget_query.rb +149 -0
  95. data/lib/datadog_api_client/v1/models/slo_list_widget_request.rb +143 -0
  96. data/lib/datadog_api_client/v1/models/slo_list_widget_request_type.rb +26 -0
  97. data/lib/datadog_api_client/v1/models/slo_overall_statuses.rb +174 -0
  98. data/lib/datadog_api_client/v1/models/slo_raw_error_budget_remaining.rb +121 -0
  99. data/lib/datadog_api_client/v1/models/synthetics_assertion_operator.rb +1 -0
  100. data/lib/datadog_api_client/v1/models/synthetics_basic_auth.rb +2 -1
  101. data/lib/datadog_api_client/v1/models/synthetics_basic_auth_digest.rb +155 -0
  102. data/lib/datadog_api_client/v1/models/synthetics_basic_auth_digest_type.rb +26 -0
  103. data/lib/datadog_api_client/v1/models/synthetics_global_variable_parse_test_options.rb +11 -12
  104. data/lib/datadog_api_client/v1/models/synthetics_global_variable_parse_test_options_type.rb +1 -0
  105. data/lib/datadog_api_client/v1/models/synthetics_test_options.rb +31 -1
  106. data/lib/datadog_api_client/v1/models/synthetics_test_process_status.rb +0 -1
  107. data/lib/datadog_api_client/v1/models/synthetics_test_request.rb +15 -1
  108. data/lib/datadog_api_client/v1/models/topology_map_widget_definition.rb +193 -0
  109. data/lib/datadog_api_client/v1/models/topology_map_widget_definition_type.rb +26 -0
  110. data/lib/datadog_api_client/v1/models/topology_query.rb +144 -0
  111. data/lib/datadog_api_client/v1/models/topology_query_data_source.rb +27 -0
  112. data/lib/datadog_api_client/v1/models/topology_request.rb +121 -0
  113. data/lib/datadog_api_client/v1/models/topology_request_type.rb +26 -0
  114. data/lib/datadog_api_client/v1/models/usage_attribution_sort.rb +4 -0
  115. data/lib/datadog_api_client/v1/models/usage_attribution_supported_metrics.rb +4 -0
  116. data/lib/datadog_api_client/v1/models/usage_attribution_values.rb +41 -1
  117. data/lib/datadog_api_client/v1/models/usage_billable_summary_hour.rb +11 -1
  118. data/lib/datadog_api_client/v1/models/usage_cloud_security_posture_management_hour.rb +12 -1
  119. data/lib/datadog_api_client/v1/models/usage_fargate_hour.rb +11 -1
  120. data/lib/datadog_api_client/v1/models/usage_summary_date.rb +21 -1
  121. data/lib/datadog_api_client/v1/models/usage_summary_date_org.rb +31 -1
  122. data/lib/datadog_api_client/v1/models/usage_summary_response.rb +21 -1
  123. data/lib/datadog_api_client/v1/models/widget_definition.rb +3 -1
  124. data/lib/datadog_api_client/v1/models/widget_monitor_summary_sort.rb +2 -0
  125. data/lib/datadog_api_client/v2/api/events_api.rb +1 -1
  126. data/lib/datadog_api_client/v2/api/incident_services_api.rb +2 -2
  127. data/lib/datadog_api_client/v2/api/incident_teams_api.rb +2 -2
  128. data/lib/datadog_api_client/v2/api/incidents_api.rb +155 -0
  129. data/lib/datadog_api_client/v2/api/logs_api.rb +1 -1
  130. data/lib/datadog_api_client/v2/api/metrics_api.rb +77 -9
  131. data/lib/datadog_api_client/v2/api/rum_api.rb +329 -0
  132. data/lib/datadog_api_client/v2/api/security_monitoring_api.rb +68 -3
  133. data/lib/datadog_api_client/v2/api/usage_metering_api.rb +83 -17
  134. data/lib/datadog_api_client/v2/models/content_encoding.rb +1 -0
  135. data/lib/datadog_api_client/v2/models/incident_attachment_attachment_type.rb +27 -0
  136. data/lib/datadog_api_client/v2/models/incident_attachment_attributes.rb +63 -0
  137. data/lib/datadog_api_client/v2/models/incident_attachment_data.rb +187 -0
  138. data/lib/datadog_api_client/v2/models/incident_attachment_link_attachment_type.rb +26 -0
  139. data/lib/datadog_api_client/v2/models/incident_attachment_link_attributes.rb +145 -0
  140. data/lib/datadog_api_client/v2/models/incident_attachment_link_attributes_attachment_object.rb +143 -0
  141. data/lib/datadog_api_client/v2/models/incident_attachment_postmortem_attachment_type.rb +26 -0
  142. data/lib/datadog_api_client/v2/models/incident_attachment_postmortem_attributes.rb +145 -0
  143. data/lib/datadog_api_client/v2/models/incident_attachment_related_object.rb +26 -0
  144. data/lib/datadog_api_client/v2/models/incident_attachment_relationships.rb +111 -0
  145. data/lib/datadog_api_client/v2/models/incident_attachment_type.rb +26 -0
  146. data/lib/datadog_api_client/v2/models/incident_attachment_update_attributes.rb +63 -0
  147. data/lib/datadog_api_client/v2/models/incident_attachment_update_data.rb +144 -0
  148. data/lib/datadog_api_client/v2/models/incident_attachment_update_request.rb +127 -0
  149. data/lib/datadog_api_client/v2/models/incident_attachment_update_response.rb +137 -0
  150. data/lib/datadog_api_client/v2/models/incident_attachments_postmortem_attributes_attachment_object.rb +143 -0
  151. data/lib/datadog_api_client/v2/models/incident_attachments_response.rb +136 -0
  152. data/lib/datadog_api_client/v2/models/incident_attachments_response_included_item.rb +62 -0
  153. data/lib/datadog_api_client/v2/models/incident_related_object.rb +1 -0
  154. data/lib/datadog_api_client/v2/models/incident_response_attributes.rb +1 -11
  155. data/lib/datadog_api_client/v2/models/incident_response_included_item.rb +2 -1
  156. data/lib/datadog_api_client/v2/models/incident_response_relationships.rb +14 -14
  157. data/lib/datadog_api_client/v2/models/metric_active_configuration_type.rb +26 -0
  158. data/lib/datadog_api_client/v2/models/metric_content_encoding.rb +2 -0
  159. data/lib/datadog_api_client/v2/models/metric_suggested_tags_and_aggregations.rb +133 -0
  160. data/lib/datadog_api_client/v2/models/metric_suggested_tags_and_aggregations_response.rb +111 -0
  161. data/lib/datadog_api_client/v2/models/metric_suggested_tags_attributes.rb +125 -0
  162. data/lib/datadog_api_client/v2/models/relationship_to_incident_attachment.rb +124 -0
  163. data/lib/datadog_api_client/v2/models/relationship_to_incident_attachment_data.rb +145 -0
  164. data/lib/datadog_api_client/v2/models/role_update_data.rb +11 -1
  165. data/lib/datadog_api_client/v2/models/rum_application.rb +166 -0
  166. data/lib/datadog_api_client/v2/models/rum_application_attributes.rb +279 -0
  167. data/lib/datadog_api_client/v2/models/rum_application_create.rb +145 -0
  168. data/lib/datadog_api_client/v2/models/rum_application_create_attributes.rb +132 -0
  169. data/lib/datadog_api_client/v2/models/rum_application_create_request.rb +122 -0
  170. data/lib/datadog_api_client/v2/models/rum_application_create_type.rb +26 -0
  171. data/lib/datadog_api_client/v2/models/rum_application_response.rb +111 -0
  172. data/lib/datadog_api_client/v2/models/rum_application_type.rb +26 -0
  173. data/lib/datadog_api_client/v2/models/rum_application_update.rb +155 -0
  174. data/lib/datadog_api_client/v2/models/rum_application_update_attributes.rb +121 -0
  175. data/lib/datadog_api_client/v2/models/rum_application_update_request.rb +122 -0
  176. data/lib/datadog_api_client/v2/models/rum_application_update_type.rb +26 -0
  177. data/lib/datadog_api_client/v2/models/rum_applications_response.rb +113 -0
  178. data/lib/datadog_api_client/v2/models/security_monitoring_rule_create_payload.rb +36 -248
  179. data/lib/datadog_api_client/v2/models/security_monitoring_rule_query.rb +36 -151
  180. data/lib/datadog_api_client/v2/models/security_monitoring_rule_query_aggregation.rb +1 -0
  181. data/lib/datadog_api_client/v2/models/security_monitoring_rule_response.rb +37 -253
  182. data/lib/datadog_api_client/v2/models/security_monitoring_signal_rule_create_payload.rb +275 -0
  183. data/lib/datadog_api_client/v2/models/security_monitoring_signal_rule_query.rb +187 -0
  184. data/lib/datadog_api_client/v2/models/security_monitoring_signal_rule_response.rb +279 -0
  185. data/lib/datadog_api_client/v2/models/security_monitoring_signal_rule_type.rb +26 -0
  186. data/lib/datadog_api_client/v2/models/security_monitoring_standard_rule_create_payload.rb +275 -0
  187. data/lib/datadog_api_client/v2/models/{security_monitoring_rule_query_create.rb → security_monitoring_standard_rule_query.rb} +3 -3
  188. data/lib/datadog_api_client/v2/models/security_monitoring_standard_rule_response.rb +279 -0
  189. data/lib/datadog_api_client/version.rb +1 -1
  190. metadata +97 -6
  191. data/Makefile +0 -7
  192. data/examples/v2/metrics/ListTagConfigurations_1799362914.rb +0 -8
@@ -145,6 +145,26 @@ components:
145
145
  required: true
146
146
  schema:
147
147
  type: string
148
+ IncidentAttachmentFilterQueryParameter:
149
+ description: Specifies which types of attachments are included in the response.
150
+ explode: false
151
+ in: query
152
+ name: filter[attachment_type]
153
+ required: false
154
+ schema:
155
+ items:
156
+ $ref: '#/components/schemas/IncidentAttachmentAttachmentType'
157
+ type: array
158
+ IncidentAttachmentIncludeQueryParameter:
159
+ description: Specifies which types of related objects are included in the response.
160
+ explode: false
161
+ in: query
162
+ name: include
163
+ required: false
164
+ schema:
165
+ items:
166
+ $ref: '#/components/schemas/IncidentAttachmentRelatedObject'
167
+ type: array
148
168
  IncidentIDPathParameter:
149
169
  description: The UUID of the incident.
150
170
  in: path
@@ -1270,10 +1290,12 @@ components:
1270
1290
  ContentEncoding:
1271
1291
  description: HTTP header used to compress the media-type.
1272
1292
  enum:
1293
+ - identity
1273
1294
  - gzip
1274
1295
  - deflate
1275
1296
  type: string
1276
1297
  x-enum-varnames:
1298
+ - IDENTITY
1277
1299
  - GZIP
1278
1300
  - DEFLATE
1279
1301
  CostByOrg:
@@ -1869,7 +1891,6 @@ components:
1869
1891
  description: The API key.
1870
1892
  readOnly: true
1871
1893
  type: string
1872
- x-secret: true
1873
1894
  last4:
1874
1895
  description: The last four characters of the API key.
1875
1896
  example: abcd
@@ -1877,7 +1898,6 @@ components:
1877
1898
  minLength: 4
1878
1899
  readOnly: true
1879
1900
  type: string
1880
- x-secret: true
1881
1901
  modified_at:
1882
1902
  description: Date the API key was last modified.
1883
1903
  example: '2020-11-23T10:00:00.000Z'
@@ -1913,7 +1933,6 @@ components:
1913
1933
  description: The application key.
1914
1934
  readOnly: true
1915
1935
  type: string
1916
- x-secret: true
1917
1936
  last4:
1918
1937
  description: The last four characters of the application key.
1919
1938
  example: abcd
@@ -1921,7 +1940,6 @@ components:
1921
1940
  minLength: 4
1922
1941
  readOnly: true
1923
1942
  type: string
1924
- x-secret: true
1925
1943
  name:
1926
1944
  description: Name of the application key.
1927
1945
  example: Application Key for managing dashboards
@@ -2116,6 +2134,243 @@ components:
2116
2134
  type: string
2117
2135
  x-mimetype: application/xml
2118
2136
  type: object
2137
+ IncidentAttachmentAttachmentType:
2138
+ description: The type of the incident attachment attributes.
2139
+ enum:
2140
+ - link
2141
+ - postmortem
2142
+ example: link
2143
+ type: string
2144
+ x-enum-varnames:
2145
+ - LINK
2146
+ - POSTMORTEM
2147
+ IncidentAttachmentAttributes:
2148
+ description: The attributes object for an attachment.
2149
+ oneOf:
2150
+ - $ref: '#/components/schemas/IncidentAttachmentPostmortemAttributes'
2151
+ - $ref: '#/components/schemas/IncidentAttachmentLinkAttributes'
2152
+ type: object
2153
+ IncidentAttachmentData:
2154
+ description: A single incident attachment.
2155
+ example:
2156
+ attributes:
2157
+ attachment:
2158
+ documentUrl: ''
2159
+ title: Postmortem IR-123
2160
+ attachment_type: postmortem
2161
+ id: 00000000-abcd-0002-0000-000000000000
2162
+ relationships:
2163
+ last_modified_by_user:
2164
+ data:
2165
+ id: 00000000-0000-0000-cccc-000000000000
2166
+ type: users
2167
+ type: incident_attachments
2168
+ properties:
2169
+ attributes:
2170
+ $ref: '#/components/schemas/IncidentAttachmentAttributes'
2171
+ id:
2172
+ description: A unique identifier that represents the incident attachment.
2173
+ example: 00000000-abcd-0001-0000-000000000000
2174
+ type: string
2175
+ relationships:
2176
+ $ref: '#/components/schemas/IncidentAttachmentRelationships'
2177
+ type:
2178
+ $ref: '#/components/schemas/IncidentAttachmentType'
2179
+ required:
2180
+ - type
2181
+ - attributes
2182
+ - id
2183
+ - relationships
2184
+ type: object
2185
+ IncidentAttachmentLinkAttachmentType:
2186
+ default: link
2187
+ description: The type of link attachment attributes.
2188
+ enum:
2189
+ - link
2190
+ example: link
2191
+ type: string
2192
+ x-enum-varnames:
2193
+ - LINK
2194
+ IncidentAttachmentLinkAttributes:
2195
+ description: The attributes object for a link attachment.
2196
+ properties:
2197
+ attachment:
2198
+ $ref: '#/components/schemas/IncidentAttachmentLinkAttributesAttachmentObject'
2199
+ attachment_type:
2200
+ $ref: '#/components/schemas/IncidentAttachmentLinkAttachmentType'
2201
+ required:
2202
+ - attachment_type
2203
+ - attachment
2204
+ type: object
2205
+ IncidentAttachmentLinkAttributesAttachmentObject:
2206
+ description: The link attachment.
2207
+ properties:
2208
+ documentUrl:
2209
+ description: The URL of this link attachment.
2210
+ example: https://www.example.com/webstore-failure-runbook
2211
+ type: string
2212
+ title:
2213
+ description: The title of this link attachment.
2214
+ example: Runbook for webstore service failures
2215
+ type: string
2216
+ required:
2217
+ - documentUrl
2218
+ - title
2219
+ type: object
2220
+ IncidentAttachmentPostmortemAttachmentType:
2221
+ default: postmortem
2222
+ description: The type of postmortem attachment attributes.
2223
+ enum:
2224
+ - postmortem
2225
+ example: postmortem
2226
+ type: string
2227
+ x-enum-varnames:
2228
+ - POSTMORTEM
2229
+ IncidentAttachmentPostmortemAttributes:
2230
+ description: The attributes object for a postmortem attachment.
2231
+ properties:
2232
+ attachment:
2233
+ $ref: '#/components/schemas/IncidentAttachmentsPostmortemAttributesAttachmentObject'
2234
+ attachment_type:
2235
+ $ref: '#/components/schemas/IncidentAttachmentPostmortemAttachmentType'
2236
+ required:
2237
+ - attachment_type
2238
+ - attachment
2239
+ type: object
2240
+ IncidentAttachmentRelatedObject:
2241
+ description: The object related to an incident attachment.
2242
+ enum:
2243
+ - users
2244
+ type: string
2245
+ x-enum-varnames:
2246
+ - USERS
2247
+ IncidentAttachmentRelationships:
2248
+ description: The incident attachment's relationships.
2249
+ properties:
2250
+ last_modified_by_user:
2251
+ $ref: '#/components/schemas/RelationshipToUser'
2252
+ type: object
2253
+ IncidentAttachmentType:
2254
+ default: incident_attachments
2255
+ description: The incident attachment resource type.
2256
+ enum:
2257
+ - incident_attachments
2258
+ example: incident_attachments
2259
+ type: string
2260
+ x-enum-varnames:
2261
+ - INCIDENT_ATTACHMENTS
2262
+ IncidentAttachmentUpdateAttributes:
2263
+ description: Incident attachment attributes.
2264
+ oneOf:
2265
+ - $ref: '#/components/schemas/IncidentAttachmentPostmortemAttributes'
2266
+ - $ref: '#/components/schemas/IncidentAttachmentLinkAttributes'
2267
+ type: object
2268
+ IncidentAttachmentUpdateData:
2269
+ description: A single incident attachment.
2270
+ properties:
2271
+ attributes:
2272
+ $ref: '#/components/schemas/IncidentAttachmentUpdateAttributes'
2273
+ id:
2274
+ description: A unique identifier that represents the incident attachment.
2275
+ example: 00000000-abcd-0001-0000-000000000000
2276
+ type: string
2277
+ type:
2278
+ $ref: '#/components/schemas/IncidentAttachmentType'
2279
+ required:
2280
+ - type
2281
+ type: object
2282
+ IncidentAttachmentUpdateRequest:
2283
+ description: The update request for an incident's attachments.
2284
+ properties:
2285
+ data:
2286
+ description: 'An array of incident attachments. An attachment object without
2287
+ an "id" key indicates that you want to
2288
+
2289
+ create that attachment. An attachment object without an "attributes" key
2290
+ indicates that you want to
2291
+
2292
+ delete that attachment. An attachment object with both the "id" key and
2293
+ a populated "attributes" object
2294
+
2295
+ indicates that you want to update that attachment.'
2296
+ example:
2297
+ - attributes:
2298
+ attachment:
2299
+ documentUrl: https://app.datadoghq.com/notebook/123
2300
+ title: Postmortem IR-123
2301
+ attachment_type: postmortem
2302
+ id: 00000000-abcd-0002-0000-000000000000
2303
+ type: incident_attachments
2304
+ - attributes:
2305
+ attachment:
2306
+ documentUrl: https://www.example.com/webstore-failure-runbook
2307
+ title: Runbook for webstore service failures
2308
+ attachment_type: link
2309
+ type: incident_attachments
2310
+ - id: 00000000-abcd-0003-0000-000000000000
2311
+ type: incident_attachments
2312
+ items:
2313
+ $ref: '#/components/schemas/IncidentAttachmentUpdateData'
2314
+ type: array
2315
+ required:
2316
+ - data
2317
+ type: object
2318
+ IncidentAttachmentUpdateResponse:
2319
+ description: The response object containing the created or updated incident
2320
+ attachments.
2321
+ properties:
2322
+ data:
2323
+ description: 'An array of incident attachments. Only the attachments that
2324
+ were created or updated by the request are
2325
+
2326
+ returned.'
2327
+ items:
2328
+ $ref: '#/components/schemas/IncidentAttachmentData'
2329
+ type: array
2330
+ included:
2331
+ description: Included related resources that the user requested.
2332
+ items:
2333
+ $ref: '#/components/schemas/IncidentAttachmentsResponseIncludedItem'
2334
+ type: array
2335
+ required:
2336
+ - data
2337
+ type: object
2338
+ IncidentAttachmentsPostmortemAttributesAttachmentObject:
2339
+ description: The postmortem attachment.
2340
+ properties:
2341
+ documentUrl:
2342
+ description: The URL of this notebook attachment.
2343
+ example: https://app.datadoghq.com/notebook/123
2344
+ type: string
2345
+ title:
2346
+ description: The title of this postmortem attachment.
2347
+ example: Postmortem IR-123
2348
+ type: string
2349
+ required:
2350
+ - documentUrl
2351
+ - title
2352
+ type: object
2353
+ IncidentAttachmentsResponse:
2354
+ description: The response object containing an incident's attachments.
2355
+ properties:
2356
+ data:
2357
+ description: An array of incident attachments.
2358
+ items:
2359
+ $ref: '#/components/schemas/IncidentAttachmentData'
2360
+ type: array
2361
+ included:
2362
+ description: Included related resources that the user requested.
2363
+ items:
2364
+ $ref: '#/components/schemas/IncidentAttachmentsResponseIncludedItem'
2365
+ type: array
2366
+ required:
2367
+ - data
2368
+ type: object
2369
+ IncidentAttachmentsResponseIncludedItem:
2370
+ description: An object related to an attachment that is included in the response.
2371
+ oneOf:
2372
+ - $ref: '#/components/schemas/User'
2373
+ type: object
2119
2374
  IncidentCreateAttributes:
2120
2375
  description: The incident's attributes for a create request.
2121
2376
  properties:
@@ -2280,9 +2535,11 @@ components:
2280
2535
  description: Object related to an incident.
2281
2536
  enum:
2282
2537
  - users
2538
+ - attachments
2283
2539
  type: string
2284
2540
  x-enum-varnames:
2285
2541
  - USERS
2542
+ - ATTACHMENTS
2286
2543
  IncidentResponse:
2287
2544
  description: Response with an incident.
2288
2545
  properties:
@@ -2357,10 +2614,6 @@ components:
2357
2614
  $ref: '#/components/schemas/IncidentNotificationHandle'
2358
2615
  nullable: true
2359
2616
  type: array
2360
- postmortem_id:
2361
- description: The UUID of the postmortem object attached to the incident.
2362
- example: 00000000-0000-0000-7890-000000000000
2363
- type: string
2364
2617
  public_id:
2365
2618
  description: The monotonically increasing integer ID for the incident.
2366
2619
  example: 1
@@ -2425,6 +2678,7 @@ components:
2425
2678
  description: An object related to an incident that is included in the response.
2426
2679
  oneOf:
2427
2680
  - $ref: '#/components/schemas/User'
2681
+ - $ref: '#/components/schemas/IncidentAttachmentData'
2428
2682
  type: object
2429
2683
  IncidentResponseMeta:
2430
2684
  description: The metadata object containing pagination metadata.
@@ -2456,6 +2710,8 @@ components:
2456
2710
  IncidentResponseRelationships:
2457
2711
  description: The incident's relationships from a response.
2458
2712
  properties:
2713
+ attachments:
2714
+ $ref: '#/components/schemas/RelationshipToIncidentAttachment'
2459
2715
  commander_user:
2460
2716
  $ref: '#/components/schemas/NullableRelationshipToUser'
2461
2717
  created_by_user:
@@ -2464,8 +2720,6 @@ components:
2464
2720
  $ref: '#/components/schemas/RelationshipToIncidentIntegrationMetadatas'
2465
2721
  last_modified_by_user:
2466
2722
  $ref: '#/components/schemas/RelationshipToUser'
2467
- postmortem:
2468
- $ref: '#/components/schemas/RelationshipToIncidentPostmortem'
2469
2723
  type: object
2470
2724
  IncidentServiceCreateAttributes:
2471
2725
  description: The incident service's attributes for a create request.
@@ -2936,7 +3190,6 @@ components:
2936
3190
  customer_impacted: false
2937
3191
  detected: '2020-04-14T00:00:00+00:00'
2938
3192
  modified: '2020-09-17T14:16:58.696424+00:00'
2939
- postmortem_id: 00000000-0000-bbbb-0000-000000000000
2940
3193
  public_id: 1
2941
3194
  resolved: null
2942
3195
  severity: SEV-1
@@ -2947,6 +3200,12 @@ components:
2947
3200
  title: Example Incident
2948
3201
  id: 00000000-aaaa-0000-0000-000000000000
2949
3202
  relationships:
3203
+ attachments:
3204
+ data:
3205
+ - id: 00000000-9999-0000-0000-000000000000
3206
+ type: incident_attachments
3207
+ - id: 00000000-1234-0000-0000-000000000000
3208
+ type: incident_attachments
2950
3209
  commander_user:
2951
3210
  data:
2952
3211
  id: 00000000-0000-0000-cccc-000000000000
@@ -2965,10 +3224,6 @@ components:
2965
3224
  data:
2966
3225
  id: 00000000-0000-0000-cccc-000000000000
2967
3226
  type: users
2968
- postmortem:
2969
- data:
2970
- id: 00000000-9999-0000-0000-000000000000
2971
- type: incident_postmortems
2972
3227
  type: incidents
2973
3228
  - attributes:
2974
3229
  created: '2020-04-21T15:34:08.627205+00:00'
@@ -2980,7 +3235,6 @@ components:
2980
3235
  customer_impacted: false
2981
3236
  detected: '2020-04-14T00:00:00+00:00'
2982
3237
  modified: '2020-09-17T14:16:58.696424+00:00'
2983
- postmortem_id: 00000000-6006-0000-0000-000000000000
2984
3238
  public_id: 2
2985
3239
  resolved: null
2986
3240
  severity: SEV-5
@@ -2991,6 +3245,10 @@ components:
2991
3245
  title: Example Incident 2
2992
3246
  id: 00000000-1111-0000-0000-000000000000
2993
3247
  relationships:
3248
+ attachments:
3249
+ data:
3250
+ - id: 00000000-9999-0000-0000-000000000000
3251
+ type: incident_attachments
2994
3252
  commander_user:
2995
3253
  data:
2996
3254
  id: 00000000-aaaa-0000-0000-000000000000
@@ -3009,10 +3267,6 @@ components:
3009
3267
  data:
3010
3268
  id: 00000000-aaaa-0000-0000-000000000000
3011
3269
  type: users
3012
- postmortem:
3013
- data:
3014
- id: 00000000-6006-0000-0000-000000000000
3015
- type: incident_postmortems
3016
3270
  type: incidents
3017
3271
  items:
3018
3272
  $ref: '#/components/schemas/IncidentResponseData'
@@ -4158,6 +4412,15 @@ components:
4158
4412
  type:
4159
4413
  $ref: '#/components/schemas/MetricType'
4160
4414
  type: object
4415
+ MetricActiveConfigurationType:
4416
+ default: actively_queried_configurations
4417
+ description: The metric actively queried configuration resource type.
4418
+ enum:
4419
+ - actively_queried_configurations
4420
+ example: actively_queried_configurations
4421
+ type: string
4422
+ x-enum-varnames:
4423
+ - ACTIVELY_QUERIED_CONFIGURATIONS
4161
4424
  MetricAllTags:
4162
4425
  description: Object for a single metric's indexed tags.
4163
4426
  properties:
@@ -4321,9 +4584,14 @@ components:
4321
4584
  description: HTTP header used to compress the media-type.
4322
4585
  enum:
4323
4586
  - deflate
4587
+ - zstd1
4588
+ - gzip
4589
+ example: deflate
4324
4590
  type: string
4325
4591
  x-enum-varnames:
4326
4592
  - DEFLATE
4593
+ - ZSTD1
4594
+ - GZIP
4327
4595
  MetricCustomAggregation:
4328
4596
  description: A time and space aggregation combination for use in query.
4329
4597
  example:
@@ -4678,6 +4946,50 @@ components:
4678
4946
  - metric
4679
4947
  - points
4680
4948
  type: object
4949
+ MetricSuggestedAggregations:
4950
+ description: List of aggregation combinations that have been actively queried.
4951
+ example:
4952
+ - space: sum
4953
+ time: sum
4954
+ - space: sum
4955
+ time: count
4956
+ items:
4957
+ $ref: '#/components/schemas/MetricCustomAggregation'
4958
+ type: array
4959
+ MetricSuggestedTagsAndAggregations:
4960
+ description: Object for a single metric's actively queried tags and aggregations.
4961
+ properties:
4962
+ attributes:
4963
+ $ref: '#/components/schemas/MetricSuggestedTagsAttributes'
4964
+ id:
4965
+ $ref: '#/components/schemas/MetricName'
4966
+ type:
4967
+ $ref: '#/components/schemas/MetricActiveConfigurationType'
4968
+ type: object
4969
+ MetricSuggestedTagsAndAggregationsResponse:
4970
+ description: Response object that includes a single metric's actively queried
4971
+ tags and aggregations.
4972
+ properties:
4973
+ data:
4974
+ $ref: '#/components/schemas/MetricSuggestedTagsAndAggregations'
4975
+ readOnly: true
4976
+ type: object
4977
+ MetricSuggestedTagsAttributes:
4978
+ description: Object containing the definition of a metric's actively queried
4979
+ tags and aggregations.
4980
+ properties:
4981
+ active_aggregations:
4982
+ $ref: '#/components/schemas/MetricSuggestedAggregations'
4983
+ active_tags:
4984
+ description: List of tag keys that have been actively queried.
4985
+ example:
4986
+ - app
4987
+ - datacenter
4988
+ items:
4989
+ description: Actively queried tag keys.
4990
+ type: string
4991
+ type: array
4992
+ type: object
4681
4993
  MetricTagConfiguration:
4682
4994
  description: Object for a single metric tag configuration.
4683
4995
  example:
@@ -5249,7 +5561,6 @@ components:
5249
5561
  minLength: 4
5250
5562
  readOnly: true
5251
5563
  type: string
5252
- x-secret: true
5253
5564
  modified_at:
5254
5565
  description: Date the API key was last modified.
5255
5566
  example: '2020-11-23T10:00:00.000Z'
@@ -5288,7 +5599,6 @@ components:
5288
5599
  minLength: 4
5289
5600
  readOnly: true
5290
5601
  type: string
5291
- x-secret: true
5292
5602
  name:
5293
5603
  description: Name of the application key.
5294
5604
  example: Application Key for managing dashboards
@@ -5603,6 +5913,187 @@ components:
5603
5913
  meta:
5604
5914
  $ref: '#/components/schemas/RUMResponseMetadata'
5605
5915
  type: object
5916
+ RUMApplication:
5917
+ description: RUM application.
5918
+ properties:
5919
+ attributes:
5920
+ $ref: '#/components/schemas/RUMApplicationAttributes'
5921
+ id:
5922
+ description: RUM application ID.
5923
+ example: abcd1234-0000-0000-abcd-1234abcd5678
5924
+ type: string
5925
+ type:
5926
+ $ref: '#/components/schemas/RUMApplicationType'
5927
+ required:
5928
+ - attributes
5929
+ - id
5930
+ - type
5931
+ type: object
5932
+ RUMApplicationAttributes:
5933
+ description: RUM application attributes.
5934
+ properties:
5935
+ application_id:
5936
+ description: ID of the RUM application.
5937
+ example: abcd1234-0000-0000-abcd-1234abcd5678
5938
+ type: string
5939
+ created_at:
5940
+ description: Timestamp in ms of the creation date.
5941
+ example: 1659479836169
5942
+ format: int64
5943
+ type: integer
5944
+ created_by_handle:
5945
+ description: Handle of the creator user.
5946
+ example: john.doe
5947
+ type: string
5948
+ hash:
5949
+ description: Client token of the RUM application.
5950
+ example: abcd1234efgh5678ijkl90abcd1234efgh0
5951
+ type: string
5952
+ name:
5953
+ description: Name of the RUM application.
5954
+ example: my_rum_application
5955
+ type: string
5956
+ org_id:
5957
+ description: Org ID of the RUM application.
5958
+ example: 999
5959
+ format: int32
5960
+ type: integer
5961
+ type:
5962
+ description: Type of the RUM application. Supported values are `browser`,
5963
+ `ios`, `android`, `react-native`, `flutter`.
5964
+ example: browser
5965
+ type: string
5966
+ updated_at:
5967
+ description: Timestamp in ms of the last update date.
5968
+ example: 1659479836169
5969
+ format: int64
5970
+ type: integer
5971
+ updated_by_handle:
5972
+ description: Handle of the updater user.
5973
+ example: jane.doe
5974
+ type: string
5975
+ required:
5976
+ - application_id
5977
+ - created_at
5978
+ - created_by_handle
5979
+ - name
5980
+ - org_id
5981
+ - type
5982
+ - updated_at
5983
+ - updated_by_handle
5984
+ type: object
5985
+ RUMApplicationCreate:
5986
+ description: RUM application creation.
5987
+ properties:
5988
+ attributes:
5989
+ $ref: '#/components/schemas/RUMApplicationCreateAttributes'
5990
+ type:
5991
+ $ref: '#/components/schemas/RUMApplicationCreateType'
5992
+ required:
5993
+ - attributes
5994
+ - type
5995
+ type: object
5996
+ RUMApplicationCreateAttributes:
5997
+ description: RUM application creation attributes.
5998
+ properties:
5999
+ name:
6000
+ description: Name of the RUM application.
6001
+ example: my_new_rum_application
6002
+ type: string
6003
+ type:
6004
+ description: Type of the RUM application. Supported values are `browser`,
6005
+ `ios`, `android`, `react-native`, `flutter`.
6006
+ example: browser
6007
+ type: string
6008
+ required:
6009
+ - name
6010
+ type: object
6011
+ RUMApplicationCreateRequest:
6012
+ description: RUM application creation request attributes.
6013
+ properties:
6014
+ data:
6015
+ $ref: '#/components/schemas/RUMApplicationCreate'
6016
+ required:
6017
+ - data
6018
+ type: object
6019
+ RUMApplicationCreateType:
6020
+ default: rum_application_create
6021
+ description: RUM application creation type.
6022
+ enum:
6023
+ - rum_application_create
6024
+ example: rum_application_create
6025
+ type: string
6026
+ x-enum-varnames:
6027
+ - RUM_APPLICATION_CREATE
6028
+ RUMApplicationResponse:
6029
+ description: RUM application response.
6030
+ properties:
6031
+ data:
6032
+ $ref: '#/components/schemas/RUMApplication'
6033
+ type: object
6034
+ RUMApplicationType:
6035
+ default: rum_application
6036
+ description: RUM application response type.
6037
+ enum:
6038
+ - rum_application
6039
+ example: rum_application
6040
+ type: string
6041
+ x-enum-varnames:
6042
+ - RUM_APPLICATION
6043
+ RUMApplicationUpdate:
6044
+ description: RUM application update.
6045
+ properties:
6046
+ attributes:
6047
+ $ref: '#/components/schemas/RUMApplicationUpdateAttributes'
6048
+ id:
6049
+ description: RUM application ID.
6050
+ example: abcd1234-0000-0000-abcd-1234abcd5678
6051
+ type: string
6052
+ type:
6053
+ $ref: '#/components/schemas/RUMApplicationUpdateType'
6054
+ required:
6055
+ - id
6056
+ - type
6057
+ type: object
6058
+ RUMApplicationUpdateAttributes:
6059
+ description: RUM application update attributes.
6060
+ properties:
6061
+ name:
6062
+ description: Name of the RUM application.
6063
+ example: updated_name_for_my_existing_rum_application
6064
+ type: string
6065
+ type:
6066
+ description: Type of the RUM application. Supported values are `browser`,
6067
+ `ios`, `android`, `react-native`, `flutter`.
6068
+ example: browser
6069
+ type: string
6070
+ type: object
6071
+ RUMApplicationUpdateRequest:
6072
+ description: RUM application update request.
6073
+ properties:
6074
+ data:
6075
+ $ref: '#/components/schemas/RUMApplicationUpdate'
6076
+ required:
6077
+ - data
6078
+ type: object
6079
+ RUMApplicationUpdateType:
6080
+ default: rum_application_update
6081
+ description: RUM application update type.
6082
+ enum:
6083
+ - rum_application_update
6084
+ example: rum_application_update
6085
+ type: string
6086
+ x-enum-varnames:
6087
+ - RUM_APPLICATION_UPDATE
6088
+ RUMApplicationsResponse:
6089
+ description: RUM applications response.
6090
+ properties:
6091
+ data:
6092
+ description: RUM applications array response.
6093
+ items:
6094
+ $ref: '#/components/schemas/RUMApplication'
6095
+ type: array
6096
+ type: object
5606
6097
  RUMBucketResponse:
5607
6098
  description: Bucket values.
5608
6099
  properties:
@@ -5962,13 +6453,37 @@ components:
5962
6453
  from the other indexes
5963
6454
  type: string
5964
6455
  type: object
5965
- RelationshipToIncidentIntegrationMetadataData:
5966
- description: A relationship reference for an integration metadata object.
5967
- example:
5968
- id: 00000000-abcd-0002-0000-000000000000
5969
- type: incident_integrations
6456
+ RelationshipToIncidentAttachment:
6457
+ description: A relationship reference for attachments.
5970
6458
  properties:
5971
- id:
6459
+ data:
6460
+ description: An array of incident attachments.
6461
+ items:
6462
+ $ref: '#/components/schemas/RelationshipToIncidentAttachmentData'
6463
+ type: array
6464
+ required:
6465
+ - data
6466
+ type: object
6467
+ RelationshipToIncidentAttachmentData:
6468
+ description: The attachment relationship data.
6469
+ properties:
6470
+ id:
6471
+ description: A unique identifier that represents the attachment.
6472
+ example: 00000000-0000-abcd-1000-000000000000
6473
+ type: string
6474
+ type:
6475
+ $ref: '#/components/schemas/IncidentAttachmentType'
6476
+ required:
6477
+ - id
6478
+ - type
6479
+ type: object
6480
+ RelationshipToIncidentIntegrationMetadataData:
6481
+ description: A relationship reference for an integration metadata object.
6482
+ example:
6483
+ id: 00000000-abcd-0002-0000-000000000000
6484
+ type: incident_integrations
6485
+ properties:
6486
+ id:
5972
6487
  description: A unique identifier that represents the integration metadata.
5973
6488
  example: 00000000-abcd-0001-0000-000000000000
5974
6489
  type: string
@@ -6345,6 +6860,8 @@ components:
6345
6860
  description: The unique identifier of the role.
6346
6861
  example: 00000000-0000-1111-0000-000000000000
6347
6862
  type: string
6863
+ relationships:
6864
+ $ref: '#/components/schemas/RoleRelationships'
6348
6865
  type:
6349
6866
  $ref: '#/components/schemas/RolesType'
6350
6867
  required:
@@ -6757,62 +7274,9 @@ components:
6757
7274
  type: object
6758
7275
  SecurityMonitoringRuleCreatePayload:
6759
7276
  description: Create a new rule.
6760
- properties:
6761
- cases:
6762
- description: Cases for generating signals.
6763
- example: []
6764
- items:
6765
- $ref: '#/components/schemas/SecurityMonitoringRuleCaseCreate'
6766
- type: array
6767
- filters:
6768
- description: Additional queries to filter matched events before they are
6769
- processed.
6770
- items:
6771
- $ref: '#/components/schemas/SecurityMonitoringFilter'
6772
- type: array
6773
- hasExtendedTitle:
6774
- description: Whether the notifications include the triggering group-by values
6775
- in their title.
6776
- example: true
6777
- type: boolean
6778
- isEnabled:
6779
- description: Whether the rule is enabled.
6780
- example: true
6781
- type: boolean
6782
- message:
6783
- description: Message for generated signals.
6784
- example: ''
6785
- type: string
6786
- name:
6787
- description: The name of the rule.
6788
- example: My security monitoring rule.
6789
- type: string
6790
- options:
6791
- $ref: '#/components/schemas/SecurityMonitoringRuleOptions'
6792
- queries:
6793
- description: Queries for selecting logs which are part of the rule.
6794
- example: []
6795
- items:
6796
- $ref: '#/components/schemas/SecurityMonitoringRuleQueryCreate'
6797
- type: array
6798
- tags:
6799
- description: Tags for generated signals.
6800
- example:
6801
- - env:prod
6802
- - team:security
6803
- items:
6804
- description: Tag.
6805
- type: string
6806
- type: array
6807
- type:
6808
- $ref: '#/components/schemas/SecurityMonitoringRuleTypeCreate'
6809
- required:
6810
- - name
6811
- - isEnabled
6812
- - queries
6813
- - options
6814
- - cases
6815
- - message
7277
+ oneOf:
7278
+ - $ref: '#/components/schemas/SecurityMonitoringStandardRuleCreatePayload'
7279
+ - $ref: '#/components/schemas/SecurityMonitoringSignalRuleCreatePayload'
6816
7280
  type: object
6817
7281
  SecurityMonitoringRuleDecreaseCriticalityBasedOnEnv:
6818
7282
  description: 'If true, signals in non-production environments have a lower severity
@@ -7037,39 +7501,9 @@ components:
7037
7501
  type: object
7038
7502
  SecurityMonitoringRuleQuery:
7039
7503
  description: Query for matching rule.
7040
- properties:
7041
- aggregation:
7042
- $ref: '#/components/schemas/SecurityMonitoringRuleQueryAggregation'
7043
- distinctFields:
7044
- description: Field for which the cardinality is measured. Sent as an array.
7045
- items:
7046
- description: Field.
7047
- type: string
7048
- type: array
7049
- groupByFields:
7050
- description: Fields to group by.
7051
- items:
7052
- description: Field.
7053
- type: string
7054
- type: array
7055
- metric:
7056
- description: 'The target field to aggregate over when using the sum or max
7057
-
7058
- aggregations.'
7059
- type: string
7060
- metrics:
7061
- description: Group of target fields to aggregate over when using the new
7062
- value aggregations.
7063
- items:
7064
- description: Field.
7065
- type: string
7066
- type: array
7067
- name:
7068
- description: Name of the query.
7069
- type: string
7070
- query:
7071
- description: Query to run on logs.
7072
- type: string
7504
+ oneOf:
7505
+ - $ref: '#/components/schemas/SecurityMonitoringStandardRuleQuery'
7506
+ - $ref: '#/components/schemas/SecurityMonitoringSignalRuleQuery'
7073
7507
  type: object
7074
7508
  SecurityMonitoringRuleQueryAggregation:
7075
7509
  description: The aggregation type.
@@ -7080,6 +7514,7 @@ components:
7080
7514
  - max
7081
7515
  - new_value
7082
7516
  - geo_data
7517
+ - event_count
7083
7518
  type: string
7084
7519
  x-enum-varnames:
7085
7520
  - COUNT
@@ -7088,112 +7523,13 @@ components:
7088
7523
  - MAX
7089
7524
  - NEW_VALUE
7090
7525
  - GEO_DATA
7091
- SecurityMonitoringRuleQueryCreate:
7092
- description: Query for matching rule.
7093
- properties:
7094
- aggregation:
7095
- $ref: '#/components/schemas/SecurityMonitoringRuleQueryAggregation'
7096
- distinctFields:
7097
- description: Field for which the cardinality is measured. Sent as an array.
7098
- items:
7099
- description: Field.
7100
- type: string
7101
- type: array
7102
- groupByFields:
7103
- description: Fields to group by.
7104
- items:
7105
- description: Field.
7106
- type: string
7107
- type: array
7108
- metric:
7109
- description: 'The target field to aggregate over when using the sum or max
7110
-
7111
- aggregations.'
7112
- type: string
7113
- metrics:
7114
- description: Group of target fields to aggregate over when using the new
7115
- value aggregations.
7116
- items:
7117
- description: Field.
7118
- type: string
7119
- type: array
7120
- name:
7121
- description: Name of the query.
7122
- type: string
7123
- query:
7124
- description: Query to run on logs.
7125
- example: a > 3
7126
- type: string
7127
- required:
7128
- - query
7129
- type: object
7526
+ - EVENT_COUNT
7130
7527
  SecurityMonitoringRuleResponse:
7131
- description: Rule.
7132
- properties:
7133
- cases:
7134
- description: Cases for generating signals.
7135
- items:
7136
- $ref: '#/components/schemas/SecurityMonitoringRuleCase'
7137
- type: array
7138
- createdAt:
7139
- description: When the rule was created, timestamp in milliseconds.
7140
- format: int64
7141
- type: integer
7142
- creationAuthorId:
7143
- description: User ID of the user who created the rule.
7144
- format: int64
7145
- type: integer
7146
- filters:
7147
- description: Additional queries to filter matched events before they are
7148
- processed.
7149
- items:
7150
- $ref: '#/components/schemas/SecurityMonitoringFilter'
7151
- type: array
7152
- hasExtendedTitle:
7153
- description: Whether the notifications include the triggering group-by values
7154
- in their title.
7155
- type: boolean
7156
- id:
7157
- description: The ID of the rule.
7158
- type: string
7159
- isDefault:
7160
- description: Whether the rule is included by default.
7161
- type: boolean
7162
- isDeleted:
7163
- description: Whether the rule has been deleted.
7164
- type: boolean
7165
- isEnabled:
7166
- description: Whether the rule is enabled.
7167
- type: boolean
7168
- message:
7169
- description: Message for generated signals.
7170
- type: string
7171
- name:
7172
- description: The name of the rule.
7173
- type: string
7174
- options:
7175
- $ref: '#/components/schemas/SecurityMonitoringRuleOptions'
7176
- queries:
7177
- description: Queries for selecting logs which are part of the rule.
7178
- items:
7179
- $ref: '#/components/schemas/SecurityMonitoringRuleQuery'
7180
- type: array
7181
- tags:
7182
- description: Tags for generated signals.
7183
- items:
7184
- description: Tag.
7185
- type: string
7186
- type: array
7187
- type:
7188
- $ref: '#/components/schemas/SecurityMonitoringRuleTypeRead'
7189
- updateAuthorId:
7190
- description: User ID of the user who updated the rule.
7191
- format: int64
7192
- type: integer
7193
- version:
7194
- description: The version of the rule.
7195
- format: int64
7196
- type: integer
7528
+ description: Create a new rule.
7529
+ oneOf:
7530
+ - $ref: '#/components/schemas/SecurityMonitoringStandardRuleResponse'
7531
+ - $ref: '#/components/schemas/SecurityMonitoringSignalRuleResponse'
7532
+ type: object
7197
7533
  SecurityMonitoringRuleSeverity:
7198
7534
  description: Severity of the Security Signal.
7199
7535
  enum:
@@ -7453,7 +7789,173 @@ components:
7453
7789
  format: int32
7454
7790
  maximum: 1000
7455
7791
  type: integer
7456
- type: object
7792
+ type: object
7793
+ SecurityMonitoringSignalRuleCreatePayload:
7794
+ description: Create a new signal correlation rule.
7795
+ properties:
7796
+ cases:
7797
+ description: Cases for generating signals.
7798
+ example: []
7799
+ items:
7800
+ $ref: '#/components/schemas/SecurityMonitoringRuleCaseCreate'
7801
+ type: array
7802
+ filters:
7803
+ description: Additional queries to filter matched events before they are
7804
+ processed.
7805
+ items:
7806
+ $ref: '#/components/schemas/SecurityMonitoringFilter'
7807
+ type: array
7808
+ hasExtendedTitle:
7809
+ description: Whether the notifications include the triggering group-by values
7810
+ in their title.
7811
+ example: true
7812
+ type: boolean
7813
+ isEnabled:
7814
+ description: Whether the rule is enabled.
7815
+ example: true
7816
+ type: boolean
7817
+ message:
7818
+ description: Message for generated signals.
7819
+ example: ''
7820
+ type: string
7821
+ name:
7822
+ description: The name of the rule.
7823
+ example: My security monitoring rule.
7824
+ type: string
7825
+ options:
7826
+ $ref: '#/components/schemas/SecurityMonitoringRuleOptions'
7827
+ queries:
7828
+ description: Queries for selecting signals which are part of the rule.
7829
+ example: []
7830
+ items:
7831
+ $ref: '#/components/schemas/SecurityMonitoringSignalRuleQuery'
7832
+ type: array
7833
+ tags:
7834
+ description: Tags for generated signals.
7835
+ example:
7836
+ - env:prod
7837
+ - team:security
7838
+ items:
7839
+ description: Tag.
7840
+ type: string
7841
+ type: array
7842
+ type:
7843
+ $ref: '#/components/schemas/SecurityMonitoringSignalRuleType'
7844
+ required:
7845
+ - name
7846
+ - isEnabled
7847
+ - queries
7848
+ - options
7849
+ - cases
7850
+ - message
7851
+ type: object
7852
+ SecurityMonitoringSignalRuleQuery:
7853
+ description: Query for matching rule on signals
7854
+ properties:
7855
+ aggregation:
7856
+ $ref: '#/components/schemas/SecurityMonitoringRuleQueryAggregation'
7857
+ correlatedByFields:
7858
+ description: Fields to group by.
7859
+ items:
7860
+ description: Field.
7861
+ type: string
7862
+ type: array
7863
+ correlatedQueryIndex:
7864
+ description: Index of the rule query used to retrieve the correlated field.
7865
+ format: int32
7866
+ maximum: 9
7867
+ type: integer
7868
+ metrics:
7869
+ description: Group of target fields to aggregate over when using the new
7870
+ value aggregations.
7871
+ items:
7872
+ description: Field.
7873
+ type: string
7874
+ type: array
7875
+ name:
7876
+ description: Name of the query.
7877
+ type: string
7878
+ ruleId:
7879
+ description: Rule ID to match on signals.
7880
+ example: d3f-ru1-e1d
7881
+ type: string
7882
+ required:
7883
+ - ruleId
7884
+ type: object
7885
+ SecurityMonitoringSignalRuleResponse:
7886
+ description: Rule.
7887
+ properties:
7888
+ cases:
7889
+ description: Cases for generating signals.
7890
+ items:
7891
+ $ref: '#/components/schemas/SecurityMonitoringRuleCase'
7892
+ type: array
7893
+ createdAt:
7894
+ description: When the rule was created, timestamp in milliseconds.
7895
+ format: int64
7896
+ type: integer
7897
+ creationAuthorId:
7898
+ description: User ID of the user who created the rule.
7899
+ format: int64
7900
+ type: integer
7901
+ filters:
7902
+ description: Additional queries to filter matched events before they are
7903
+ processed.
7904
+ items:
7905
+ $ref: '#/components/schemas/SecurityMonitoringFilter'
7906
+ type: array
7907
+ hasExtendedTitle:
7908
+ description: Whether the notifications include the triggering group-by values
7909
+ in their title.
7910
+ type: boolean
7911
+ id:
7912
+ description: The ID of the rule.
7913
+ type: string
7914
+ isDefault:
7915
+ description: Whether the rule is included by default.
7916
+ type: boolean
7917
+ isDeleted:
7918
+ description: Whether the rule has been deleted.
7919
+ type: boolean
7920
+ isEnabled:
7921
+ description: Whether the rule is enabled.
7922
+ type: boolean
7923
+ message:
7924
+ description: Message for generated signals.
7925
+ type: string
7926
+ name:
7927
+ description: The name of the rule.
7928
+ type: string
7929
+ options:
7930
+ $ref: '#/components/schemas/SecurityMonitoringRuleOptions'
7931
+ queries:
7932
+ description: Queries for selecting logs which are part of the rule.
7933
+ items:
7934
+ $ref: '#/components/schemas/SecurityMonitoringSignalRuleQuery'
7935
+ type: array
7936
+ tags:
7937
+ description: Tags for generated signals.
7938
+ items:
7939
+ description: Tag.
7940
+ type: string
7941
+ type: array
7942
+ type:
7943
+ $ref: '#/components/schemas/SecurityMonitoringSignalRuleType'
7944
+ updateAuthorId:
7945
+ description: User ID of the user who updated the rule.
7946
+ format: int64
7947
+ type: integer
7948
+ version:
7949
+ description: The version of the rule.
7950
+ format: int64
7951
+ type: integer
7952
+ SecurityMonitoringSignalRuleType:
7953
+ description: The rule type.
7954
+ enum:
7955
+ - signal_correlation
7956
+ type: string
7957
+ x-enum-varnames:
7958
+ - SIGNAL_CORRELATION
7457
7959
  SecurityMonitoringSignalState:
7458
7960
  description: The new triage state of the signal.
7459
7961
  enum:
@@ -7610,6 +8112,171 @@ components:
7610
8112
  x-enum-varnames:
7611
8113
  - TIMESTAMP_ASCENDING
7612
8114
  - TIMESTAMP_DESCENDING
8115
+ SecurityMonitoringStandardRuleCreatePayload:
8116
+ description: Create a new rule.
8117
+ properties:
8118
+ cases:
8119
+ description: Cases for generating signals.
8120
+ example: []
8121
+ items:
8122
+ $ref: '#/components/schemas/SecurityMonitoringRuleCaseCreate'
8123
+ type: array
8124
+ filters:
8125
+ description: Additional queries to filter matched events before they are
8126
+ processed.
8127
+ items:
8128
+ $ref: '#/components/schemas/SecurityMonitoringFilter'
8129
+ type: array
8130
+ hasExtendedTitle:
8131
+ description: Whether the notifications include the triggering group-by values
8132
+ in their title.
8133
+ example: true
8134
+ type: boolean
8135
+ isEnabled:
8136
+ description: Whether the rule is enabled.
8137
+ example: true
8138
+ type: boolean
8139
+ message:
8140
+ description: Message for generated signals.
8141
+ example: ''
8142
+ type: string
8143
+ name:
8144
+ description: The name of the rule.
8145
+ example: My security monitoring rule.
8146
+ type: string
8147
+ options:
8148
+ $ref: '#/components/schemas/SecurityMonitoringRuleOptions'
8149
+ queries:
8150
+ description: Queries for selecting logs which are part of the rule.
8151
+ example: []
8152
+ items:
8153
+ $ref: '#/components/schemas/SecurityMonitoringStandardRuleQuery'
8154
+ type: array
8155
+ tags:
8156
+ description: Tags for generated signals.
8157
+ example:
8158
+ - env:prod
8159
+ - team:security
8160
+ items:
8161
+ description: Tag.
8162
+ type: string
8163
+ type: array
8164
+ type:
8165
+ $ref: '#/components/schemas/SecurityMonitoringRuleTypeCreate'
8166
+ required:
8167
+ - name
8168
+ - isEnabled
8169
+ - queries
8170
+ - options
8171
+ - cases
8172
+ - message
8173
+ type: object
8174
+ SecurityMonitoringStandardRuleQuery:
8175
+ description: Query for matching rule.
8176
+ properties:
8177
+ aggregation:
8178
+ $ref: '#/components/schemas/SecurityMonitoringRuleQueryAggregation'
8179
+ distinctFields:
8180
+ description: Field for which the cardinality is measured. Sent as an array.
8181
+ items:
8182
+ description: Field.
8183
+ type: string
8184
+ type: array
8185
+ groupByFields:
8186
+ description: Fields to group by.
8187
+ items:
8188
+ description: Field.
8189
+ type: string
8190
+ type: array
8191
+ metric:
8192
+ description: 'The target field to aggregate over when using the sum or max
8193
+
8194
+ aggregations.'
8195
+ type: string
8196
+ metrics:
8197
+ description: Group of target fields to aggregate over when using the new
8198
+ value aggregations.
8199
+ items:
8200
+ description: Field.
8201
+ type: string
8202
+ type: array
8203
+ name:
8204
+ description: Name of the query.
8205
+ type: string
8206
+ query:
8207
+ description: Query to run on logs.
8208
+ example: a > 3
8209
+ type: string
8210
+ required:
8211
+ - query
8212
+ type: object
8213
+ SecurityMonitoringStandardRuleResponse:
8214
+ description: Rule.
8215
+ properties:
8216
+ cases:
8217
+ description: Cases for generating signals.
8218
+ items:
8219
+ $ref: '#/components/schemas/SecurityMonitoringRuleCase'
8220
+ type: array
8221
+ createdAt:
8222
+ description: When the rule was created, timestamp in milliseconds.
8223
+ format: int64
8224
+ type: integer
8225
+ creationAuthorId:
8226
+ description: User ID of the user who created the rule.
8227
+ format: int64
8228
+ type: integer
8229
+ filters:
8230
+ description: Additional queries to filter matched events before they are
8231
+ processed.
8232
+ items:
8233
+ $ref: '#/components/schemas/SecurityMonitoringFilter'
8234
+ type: array
8235
+ hasExtendedTitle:
8236
+ description: Whether the notifications include the triggering group-by values
8237
+ in their title.
8238
+ type: boolean
8239
+ id:
8240
+ description: The ID of the rule.
8241
+ type: string
8242
+ isDefault:
8243
+ description: Whether the rule is included by default.
8244
+ type: boolean
8245
+ isDeleted:
8246
+ description: Whether the rule has been deleted.
8247
+ type: boolean
8248
+ isEnabled:
8249
+ description: Whether the rule is enabled.
8250
+ type: boolean
8251
+ message:
8252
+ description: Message for generated signals.
8253
+ type: string
8254
+ name:
8255
+ description: The name of the rule.
8256
+ type: string
8257
+ options:
8258
+ $ref: '#/components/schemas/SecurityMonitoringRuleOptions'
8259
+ queries:
8260
+ description: Queries for selecting logs which are part of the rule.
8261
+ items:
8262
+ $ref: '#/components/schemas/SecurityMonitoringStandardRuleQuery'
8263
+ type: array
8264
+ tags:
8265
+ description: Tags for generated signals.
8266
+ items:
8267
+ description: Tag.
8268
+ type: string
8269
+ type: array
8270
+ type:
8271
+ $ref: '#/components/schemas/SecurityMonitoringRuleTypeRead'
8272
+ updateAuthorId:
8273
+ description: User ID of the user who updated the rule.
8274
+ format: int64
8275
+ type: integer
8276
+ version:
8277
+ description: The version of the rule.
8278
+ format: int64
8279
+ type: integer
7613
8280
  SecurityMonitoringTriageUser:
7614
8281
  description: Object representing a given user entity.
7615
8282
  properties:
@@ -8113,8 +8780,6 @@ paths:
8113
8780
  summary: Get all API keys
8114
8781
  tags:
8115
8782
  - Key Management
8116
- x-undo:
8117
- type: safe
8118
8783
  post:
8119
8784
  description: Create an API key.
8120
8785
  operationId: CreateAPIKey
@@ -8149,19 +8814,6 @@ paths:
8149
8814
  tags:
8150
8815
  - Key Management
8151
8816
  x-codegen-request-body-name: body
8152
- x-given:
8153
- api_key:
8154
- parameters:
8155
- - name: body
8156
- value: "{\n \"data\": {\n \"attributes\": {\n \"name\": \"{{
8157
- unique }}\"\n },\n \"type\": \"api_keys\"\n }\n}"
8158
- step: there is a valid "api_key" in the system
8159
- x-undo:
8160
- operationId: DeleteAPIKey
8161
- parameters:
8162
- - name: api_key_id
8163
- source: data.id
8164
- type: unsafe
8165
8817
  /api/v2/api_keys/{api_key_id}:
8166
8818
  delete:
8167
8819
  description: Delete an API key.
@@ -8188,8 +8840,6 @@ paths:
8188
8840
  summary: Delete an API key
8189
8841
  tags:
8190
8842
  - Key Management
8191
- x-undo:
8192
- type: idempotent
8193
8843
  get:
8194
8844
  description: Get an API key.
8195
8845
  operationId: GetAPIKey
@@ -8220,8 +8870,6 @@ paths:
8220
8870
  summary: Get API key
8221
8871
  tags:
8222
8872
  - Key Management
8223
- x-undo:
8224
- type: safe
8225
8873
  patch:
8226
8874
  description: Update an API key.
8227
8875
  operationId: UpdateAPIKey
@@ -8264,8 +8912,6 @@ paths:
8264
8912
  tags:
8265
8913
  - Key Management
8266
8914
  x-codegen-request-body-name: body
8267
- x-undo:
8268
- type: idempotent
8269
8915
  /api/v2/application_keys:
8270
8916
  get:
8271
8917
  description: List all application keys available for your org
@@ -8307,8 +8953,6 @@ paths:
8307
8953
  summary: Get all application keys
8308
8954
  tags:
8309
8955
  - Key Management
8310
- x-undo:
8311
- type: safe
8312
8956
  /api/v2/application_keys/{app_key_id}:
8313
8957
  delete:
8314
8958
  description: Delete an application key
@@ -8336,8 +8980,6 @@ paths:
8336
8980
  tags:
8337
8981
  - Key Management
8338
8982
  x-codegen-request-body-name: body
8339
- x-undo:
8340
- type: idempotent
8341
8983
  get:
8342
8984
  description: Get an application key for your org.
8343
8985
  operationId: GetApplicationKey
@@ -8374,8 +9016,6 @@ paths:
8374
9016
  summary: Get an application key
8375
9017
  tags:
8376
9018
  - Key Management
8377
- x-undo:
8378
- type: safe
8379
9019
  patch:
8380
9020
  description: Edit an application key
8381
9021
  operationId: UpdateApplicationKey
@@ -8418,8 +9058,6 @@ paths:
8418
9058
  tags:
8419
9059
  - Key Management
8420
9060
  x-codegen-request-body-name: body
8421
- x-undo:
8422
- type: idempotent
8423
9061
  /api/v2/audit/events:
8424
9062
  get:
8425
9063
  description: 'List endpoint returns events that match a Audit Logs search query.
@@ -8496,14 +9134,11 @@ paths:
8496
9134
  summary: Get a list of Audit Logs events
8497
9135
  tags:
8498
9136
  - Audit
8499
- x-menu-order: 2
8500
9137
  x-pagination:
8501
9138
  cursorParam: page[cursor]
8502
9139
  cursorPath: meta.page.after
8503
9140
  limitParam: page[limit]
8504
9141
  resultsPath: data
8505
- x-undo:
8506
- type: safe
8507
9142
  /api/v2/audit/events/search:
8508
9143
  post:
8509
9144
  description: 'List endpoint returns Audit Logs events that match an Audit search
@@ -8540,14 +9175,11 @@ paths:
8540
9175
  tags:
8541
9176
  - Audit
8542
9177
  x-codegen-request-body-name: body
8543
- x-menu-order: 1
8544
9178
  x-pagination:
8545
9179
  cursorParam: body.page.cursor
8546
9180
  cursorPath: meta.page.after
8547
9181
  limitParam: body.page.limit
8548
9182
  resultsPath: data
8549
- x-undo:
8550
- type: safe
8551
9183
  /api/v2/authn_mappings:
8552
9184
  get:
8553
9185
  description: List all AuthN Mappings in the org.
@@ -8589,10 +9221,7 @@ paths:
8589
9221
  summary: List all AuthN Mappings
8590
9222
  tags:
8591
9223
  - AuthN Mappings
8592
- x-menu-order: 4
8593
9224
  x-permission: OPEN()
8594
- x-undo:
8595
- type: safe
8596
9225
  post:
8597
9226
  description: Create an AuthN Mapping.
8598
9227
  operationId: CreateAuthNMapping
@@ -8638,25 +9267,7 @@ paths:
8638
9267
  tags:
8639
9268
  - AuthN Mappings
8640
9269
  x-codegen-request-body-name: body
8641
- x-given:
8642
- authn_mapping:
8643
- parameters:
8644
- - name: body
8645
- value: "{\n \"data\": {\n \"attributes\": {\n \"attribute_key\":
8646
- \"{{ unique_lower_alnum }}\",\n \"attribute_value\": \"{{ unique
8647
- }}\"\n },\n \"relationships\": {\n \"role\": {\n \"data\":
8648
- {\n \"id\": \"{{ role.data.id }}\",\n \"type\":
8649
- \"{{ role.data.type }}\"\n }\n }\n },\n \"type\":
8650
- \"authn_mappings\"\n }\n}"
8651
- step: there is a valid "authn_mapping" in the system
8652
- x-menu-order: 5
8653
9270
  x-permission: OR(USER_ACCESS_MANAGE)
8654
- x-undo:
8655
- operationId: DeleteAuthNMapping
8656
- parameters:
8657
- - name: authn_mapping_id
8658
- source: data.id
8659
- type: unsafe
8660
9271
  /api/v2/authn_mappings/{authn_mapping_id}:
8661
9272
  delete:
8662
9273
  description: Delete an AuthN Mapping specified by AuthN Mapping UUID.
@@ -8688,10 +9299,7 @@ paths:
8688
9299
  summary: Delete an AuthN Mapping
8689
9300
  tags:
8690
9301
  - AuthN Mappings
8691
- x-menu-order: 3
8692
9302
  x-permission: OR(USER_ACCESS_MANAGE)
8693
- x-undo:
8694
- type: idempotent
8695
9303
  get:
8696
9304
  description: Get an AuthN Mapping specified by the AuthN Mapping UUID.
8697
9305
  operationId: GetAuthNMapping
@@ -8725,10 +9333,7 @@ paths:
8725
9333
  summary: Get an AuthN Mapping by UUID
8726
9334
  tags:
8727
9335
  - AuthN Mappings
8728
- x-menu-order: 1
8729
9336
  x-permission: OPEN()
8730
- x-undo:
8731
- type: safe
8732
9337
  patch:
8733
9338
  description: Edit an AuthN Mapping.
8734
9339
  operationId: UpdateAuthNMapping
@@ -8788,10 +9393,7 @@ paths:
8788
9393
  tags:
8789
9394
  - AuthN Mappings
8790
9395
  x-codegen-request-body-name: body
8791
- x-menu-order: 2
8792
9396
  x-permission: OR(USER_ACCESS_MANAGE)
8793
- x-undo:
8794
- type: idempotent
8795
9397
  /api/v2/current_user/application_keys:
8796
9398
  get:
8797
9399
  description: List all application keys available for current user
@@ -8833,8 +9435,6 @@ paths:
8833
9435
  summary: Get all application keys owned by current user
8834
9436
  tags:
8835
9437
  - Key Management
8836
- x-undo:
8837
- type: safe
8838
9438
  post:
8839
9439
  description: Create an application key for current user
8840
9440
  operationId: CreateCurrentUserApplicationKey
@@ -8869,19 +9469,6 @@ paths:
8869
9469
  tags:
8870
9470
  - Key Management
8871
9471
  x-codegen-request-body-name: body
8872
- x-given:
8873
- application_key:
8874
- parameters:
8875
- - name: body
8876
- value: "{\n \"data\": {\n \"attributes\": {\n \"name\": \"{{
8877
- unique }}\"\n },\n \"type\": \"application_keys\"\n }\n}"
8878
- step: there is a valid "application_key" in the system
8879
- x-undo:
8880
- operationId: DeleteCurrentUserApplicationKey
8881
- parameters:
8882
- - name: app_key_id
8883
- source: data.id
8884
- type: unsafe
8885
9472
  /api/v2/current_user/application_keys/{app_key_id}:
8886
9473
  delete:
8887
9474
  description: Delete an application key owned by current user
@@ -8908,8 +9495,6 @@ paths:
8908
9495
  summary: Delete an application key owned by current user
8909
9496
  tags:
8910
9497
  - Key Management
8911
- x-undo:
8912
- type: idempotent
8913
9498
  get:
8914
9499
  description: Get an application key owned by current user
8915
9500
  operationId: GetCurrentUserApplicationKey
@@ -8939,8 +9524,6 @@ paths:
8939
9524
  summary: Get one application key owned by current user
8940
9525
  tags:
8941
9526
  - Key Management
8942
- x-undo:
8943
- type: safe
8944
9527
  patch:
8945
9528
  description: Edit an application key owned by current user
8946
9529
  operationId: UpdateCurrentUserApplicationKey
@@ -8983,8 +9566,6 @@ paths:
8983
9566
  tags:
8984
9567
  - Key Management
8985
9568
  x-codegen-request-body-name: body
8986
- x-undo:
8987
- type: idempotent
8988
9569
  /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards:
8989
9570
  delete:
8990
9571
  description: Delete dashboards from an existing dashboard list.
@@ -9035,9 +9616,6 @@ paths:
9035
9616
  tags:
9036
9617
  - Dashboard Lists
9037
9618
  x-codegen-request-body-name: body
9038
- x-menu-order: 4
9039
- x-undo:
9040
- type: idempotent
9041
9619
  get:
9042
9620
  description: "Fetch the dashboard list\u2019s dashboard definitions."
9043
9621
  operationId: GetDashboardListItems
@@ -9078,9 +9656,6 @@ paths:
9078
9656
  summary: Get items of a Dashboard List
9079
9657
  tags:
9080
9658
  - Dashboard Lists
9081
- x-menu-order: 1
9082
- x-undo:
9083
- type: safe
9084
9659
  post:
9085
9660
  description: Add dashboards to an existing dashboard list.
9086
9661
  operationId: CreateDashboardListItems
@@ -9130,26 +9705,6 @@ paths:
9130
9705
  tags:
9131
9706
  - Dashboard Lists
9132
9707
  x-codegen-request-body-name: body
9133
- x-given:
9134
- dashboard_list_dashboard:
9135
- parameters:
9136
- - name: dashboard_list_id
9137
- source: dashboard_list.id
9138
- - name: body
9139
- value: "{\n \"dashboards\": [\n {\n \"id\": \"{{ dashboard.id
9140
- }}\",\n \"type\": \"custom_timeboard\"\n }\n ]\n}"
9141
- step: the "dashboard_list" has the "dashboard"
9142
- dashboard_list_screenboard_dashboard:
9143
- parameters:
9144
- - name: dashboard_list_id
9145
- source: dashboard_list.id
9146
- - name: body
9147
- value: "{\n \"dashboards\": [\n {\n \"id\": \"{{ screenboard_dashboard.id
9148
- }}\",\n \"type\": \"custom_screenboard\"\n }\n ]\n}"
9149
- step: the "dashboard_list" has the "screenboard_dashboard"
9150
- x-menu-order: 2
9151
- x-undo:
9152
- type: safe
9153
9708
  put:
9154
9709
  description: Update dashboards of an existing dashboard list.
9155
9710
  operationId: UpdateDashboardListItems
@@ -9199,9 +9754,6 @@ paths:
9199
9754
  tags:
9200
9755
  - Dashboard Lists
9201
9756
  x-codegen-request-body-name: body
9202
- x-menu-order: 3
9203
- x-undo:
9204
- type: safe
9205
9757
  /api/v2/events:
9206
9758
  get:
9207
9759
  description: 'List endpoint returns events that match an events search query.
@@ -9275,14 +9827,11 @@ paths:
9275
9827
  summary: Get a list of events
9276
9828
  tags:
9277
9829
  - Events
9278
- x-menu-order: 1
9279
9830
  x-pagination:
9280
9831
  cursorParam: page[cursor]
9281
9832
  cursorPath: meta.page.after
9282
9833
  limitParam: page[limit]
9283
9834
  resultsPath: data
9284
- x-undo:
9285
- type: safe
9286
9835
  x-unstable: '**Note**: This endpoint is in private beta.
9287
9836
 
9288
9837
  For access, contact [Datadog support](https://docs.datadoghq.com/help/).'
@@ -9314,18 +9863,20 @@ paths:
9314
9863
  $ref: '#/components/responses/NotAuthorizedResponse'
9315
9864
  '429':
9316
9865
  $ref: '#/components/responses/TooManyRequestsResponse'
9866
+ security:
9867
+ - apiKeyAuth: []
9868
+ appKeyAuth: []
9869
+ - AuthZ:
9870
+ - events_read
9317
9871
  summary: Search events
9318
9872
  tags:
9319
9873
  - Events
9320
9874
  x-codegen-request-body-name: body
9321
- x-menu-order: 2
9322
9875
  x-pagination:
9323
9876
  cursorParam: body.page.cursor
9324
9877
  cursorPath: meta.page.after
9325
9878
  limitParam: body.page.limit
9326
9879
  resultsPath: data
9327
- x-undo:
9328
- type: safe
9329
9880
  x-unstable: '**Note**: This endpoint is in private beta.
9330
9881
 
9331
9882
  For access, contact [Datadog support](https://docs.datadoghq.com/help/).'
@@ -9366,8 +9917,6 @@ paths:
9366
9917
  limitParam: page[size]
9367
9918
  pageOffsetParam: page[offset]
9368
9919
  resultsPath: data
9369
- x-undo:
9370
- type: safe
9371
9920
  x-unstable: '**Note**: This endpoint is in public beta.
9372
9921
 
9373
9922
  If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
@@ -9407,20 +9956,6 @@ paths:
9407
9956
  tags:
9408
9957
  - Incidents
9409
9958
  x-codegen-request-body-name: body
9410
- x-given:
9411
- incident:
9412
- parameters:
9413
- - name: body
9414
- value: "{\n \"data\": {\n \"attributes\": {\n \"title\": \"{{
9415
- unique }}\",\n \"customer_impacted\": false\n },\n \"type\":
9416
- \"incidents\"\n }\n}"
9417
- step: there is a valid "incident" in the system
9418
- x-undo:
9419
- operationId: DeleteIncident
9420
- parameters:
9421
- - name: incident_id
9422
- source: data.id
9423
- type: unsafe
9424
9959
  x-unstable: '**Note**: This endpoint is in public beta.
9425
9960
 
9426
9961
  If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
@@ -9451,8 +9986,6 @@ paths:
9451
9986
  summary: Delete an existing incident
9452
9987
  tags:
9453
9988
  - Incidents
9454
- x-undo:
9455
- type: idempotent
9456
9989
  x-unstable: '**Note**: This endpoint is in public beta.
9457
9990
 
9458
9991
  If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
@@ -9487,8 +10020,6 @@ paths:
9487
10020
  summary: Get the details of an incident
9488
10021
  tags:
9489
10022
  - Incidents
9490
- x-undo:
9491
- type: safe
9492
10023
  x-unstable: '**Note**: This endpoint is in public beta.
9493
10024
 
9494
10025
  If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
@@ -9511,7 +10042,86 @@ paths:
9511
10042
  content:
9512
10043
  application/json:
9513
10044
  schema:
9514
- $ref: '#/components/schemas/IncidentResponse'
10045
+ $ref: '#/components/schemas/IncidentResponse'
10046
+ description: OK
10047
+ '400':
10048
+ $ref: '#/components/responses/BadRequestResponse'
10049
+ '401':
10050
+ $ref: '#/components/responses/UnauthorizedResponse'
10051
+ '403':
10052
+ $ref: '#/components/responses/ForbiddenResponse'
10053
+ '404':
10054
+ $ref: '#/components/responses/NotFoundResponse'
10055
+ '429':
10056
+ $ref: '#/components/responses/TooManyRequestsResponse'
10057
+ security:
10058
+ - apiKeyAuth: []
10059
+ appKeyAuth: []
10060
+ - AuthZ:
10061
+ - incident_write
10062
+ summary: Update an existing incident
10063
+ tags:
10064
+ - Incidents
10065
+ x-codegen-request-body-name: body
10066
+ x-unstable: '**Note**: This endpoint is in public beta.
10067
+
10068
+ If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
10069
+ /api/v2/incidents/{incident_id}/attachments:
10070
+ get:
10071
+ description: Get all attachments for a given incident.
10072
+ operationId: ListIncidentAttachments
10073
+ parameters:
10074
+ - $ref: '#/components/parameters/IncidentIDPathParameter'
10075
+ - $ref: '#/components/parameters/IncidentAttachmentIncludeQueryParameter'
10076
+ - $ref: '#/components/parameters/IncidentAttachmentFilterQueryParameter'
10077
+ responses:
10078
+ '200':
10079
+ content:
10080
+ application/json:
10081
+ schema:
10082
+ $ref: '#/components/schemas/IncidentAttachmentsResponse'
10083
+ description: OK
10084
+ '400':
10085
+ $ref: '#/components/responses/BadRequestResponse'
10086
+ '401':
10087
+ $ref: '#/components/responses/UnauthorizedResponse'
10088
+ '403':
10089
+ $ref: '#/components/responses/ForbiddenResponse'
10090
+ '404':
10091
+ $ref: '#/components/responses/NotFoundResponse'
10092
+ '429':
10093
+ $ref: '#/components/responses/TooManyRequestsResponse'
10094
+ security:
10095
+ - apiKeyAuth: []
10096
+ appKeyAuth: []
10097
+ - AuthZ:
10098
+ - incident_read
10099
+ summary: Get a list of attachments
10100
+ tags:
10101
+ - Incidents
10102
+ x-unstable: '**Note**: This endpoint is in public beta.
10103
+
10104
+ If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
10105
+ patch:
10106
+ description: The bulk update endpoint for creating, updating, and deleting attachments
10107
+ for a given incident.
10108
+ operationId: UpdateIncidentAttachments
10109
+ parameters:
10110
+ - $ref: '#/components/parameters/IncidentIDPathParameter'
10111
+ - $ref: '#/components/parameters/IncidentAttachmentIncludeQueryParameter'
10112
+ requestBody:
10113
+ content:
10114
+ application/json:
10115
+ schema:
10116
+ $ref: '#/components/schemas/IncidentAttachmentUpdateRequest'
10117
+ description: Incident Attachment Payload.
10118
+ required: true
10119
+ responses:
10120
+ '200':
10121
+ content:
10122
+ application/json:
10123
+ schema:
10124
+ $ref: '#/components/schemas/IncidentAttachmentUpdateResponse'
9515
10125
  description: OK
9516
10126
  '400':
9517
10127
  $ref: '#/components/responses/BadRequestResponse'
@@ -9523,17 +10133,10 @@ paths:
9523
10133
  $ref: '#/components/responses/NotFoundResponse'
9524
10134
  '429':
9525
10135
  $ref: '#/components/responses/TooManyRequestsResponse'
9526
- security:
9527
- - apiKeyAuth: []
9528
- appKeyAuth: []
9529
- - AuthZ:
9530
- - incident_write
9531
- summary: Update an existing incident
10136
+ summary: Create, update, and delete incident attachments
9532
10137
  tags:
9533
10138
  - Incidents
9534
10139
  x-codegen-request-body-name: body
9535
- x-undo:
9536
- type: idempotent
9537
10140
  x-unstable: '**Note**: This endpoint is in public beta.
9538
10141
 
9539
10142
  If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
@@ -9555,9 +10158,6 @@ paths:
9555
10158
  summary: Get all service objects
9556
10159
  tags:
9557
10160
  - Opsgenie Integration
9558
- x-menu-order: 1
9559
- x-undo:
9560
- type: safe
9561
10161
  post:
9562
10162
  description: Create a new service object in the Opsgenie integration.
9563
10163
  operationId: CreateOpsgenieService
@@ -9587,22 +10187,6 @@ paths:
9587
10187
  tags:
9588
10188
  - Opsgenie Integration
9589
10189
  x-codegen-request-body-name: body
9590
- x-given:
9591
- opsgenie_service:
9592
- parameters:
9593
- - name: body
9594
- value: "{\n \"data\": {\n \"attributes\": {\n \"name\": \"{{
9595
- unique }}\",\n \"opsgenie_api_key\": \"00000000-0000-0000-0000-000000000000\",\n
9596
- \ \"region\": \"us\"\n },\n \"type\": \"opsgenie-service\"\n
9597
- \ }\n}"
9598
- step: there is a valid "opsgenie_service" in the system
9599
- x-menu-order: 2
9600
- x-undo:
9601
- operationId: DeleteOpsgenieService
9602
- parameters:
9603
- - name: integration_service_id
9604
- source: data.id
9605
- type: unsafe
9606
10190
  /api/v2/integration/opsgenie/services/{integration_service_id}:
9607
10191
  delete:
9608
10192
  description: Delete a single service object in the Datadog Opsgenie integration.
@@ -9623,9 +10207,6 @@ paths:
9623
10207
  summary: Delete a single service object
9624
10208
  tags:
9625
10209
  - Opsgenie Integration
9626
- x-menu-order: 5
9627
- x-undo:
9628
- type: idempotent
9629
10210
  get:
9630
10211
  description: Get a single service from the Datadog Opsgenie integration.
9631
10212
  operationId: GetOpsgenieService
@@ -9651,9 +10232,6 @@ paths:
9651
10232
  summary: Get a single service object
9652
10233
  tags:
9653
10234
  - Opsgenie Integration
9654
- x-menu-order: 3
9655
- x-undo:
9656
- type: safe
9657
10235
  patch:
9658
10236
  description: Update a single service object in the Datadog Opsgenie integration.
9659
10237
  operationId: UpdateOpsgenieService
@@ -9687,9 +10265,6 @@ paths:
9687
10265
  tags:
9688
10266
  - Opsgenie Integration
9689
10267
  x-codegen-request-body-name: body
9690
- x-menu-order: 4
9691
- x-undo:
9692
- type: idempotent
9693
10268
  /api/v2/logs:
9694
10269
  post:
9695
10270
  description: 'Send your logs to your Datadog platform over HTTP. Limits per
@@ -9764,17 +10339,27 @@ paths:
9764
10339
  description: Pass multiple log objects at once.
9765
10340
  summary: Multi JSON Messages
9766
10341
  value:
9767
- - message: hello
9768
- - message: world
10342
+ - ddsource: nginx
10343
+ ddtags: env:staging,version:5.1
10344
+ hostname: i-012345678
10345
+ message: 2019-11-19T14:37:58,995 INFO [process.name][20081] Hello
10346
+ service: payment
10347
+ - ddsource: nginx
10348
+ ddtags: env:staging,version:5.1
10349
+ hostname: i-012345679
10350
+ message: 2019-11-19T14:37:58,995 INFO [process.name][20081] World
10351
+ service: payment
9769
10352
  simple-json-message:
9770
10353
  description: Log attributes can be passed as `key:value` pairs in
9771
10354
  valid JSON messages.
9772
10355
  summary: Simple JSON Message
9773
10356
  value:
9774
- ddsource: agent
9775
- ddtags: env:prod,user:joe.doe
9776
- hostname: fa1e1e739d95
9777
- message: hello world
10357
+ ddsource: nginx
10358
+ ddtags: env:staging,version:5.1
10359
+ hostname: i-012345678
10360
+ message: 2019-11-19T14:37:58,995 INFO [process.name][20081] Hello
10361
+ World
10362
+ service: payment
9778
10363
  schema:
9779
10364
  $ref: '#/components/schemas/HTTPLog'
9780
10365
  application/logplex-1:
@@ -9782,13 +10367,13 @@ paths:
9782
10367
  multi-raw-message:
9783
10368
  description: Submit log messages.
9784
10369
  summary: Multi Logplex Messages
9785
- value: 'hello
10370
+ value: '2019-11-19T14:37:58,995 INFO [process.name][20081] Hello
9786
10371
 
9787
- world'
10372
+ 2019-11-19T14:37:58,995 INFO [process.name][20081] World'
9788
10373
  simple-logplex-message:
9789
10374
  description: Submit log string.
9790
10375
  summary: Simple Logplex Message
9791
- value: hello world
10376
+ value: 2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World
9792
10377
  schema:
9793
10378
  type: string
9794
10379
  text/plain:
@@ -9796,9 +10381,9 @@ paths:
9796
10381
  multi-raw-message:
9797
10382
  description: Submit log string.
9798
10383
  summary: Multi Raw Messages
9799
- value: 'hello
10384
+ value: '2019-11-19T14:37:58,995 INFO [process.name][20081] Hello
9800
10385
 
9801
- world
10386
+ 2019-11-19T14:37:58,995 INFO [process.name][20081] World
9802
10387
 
9803
10388
  '
9804
10389
  simple-raw-message:
@@ -9806,7 +10391,7 @@ paths:
9806
10391
  parameters in the URL. This enables the addition of tags or the
9807
10392
  source by using the `ddtags` and `ddsource` parameters: `?host=my-hostname&service=my-service&ddsource=my-source&ddtags=env:prod,user:my-user`.'
9808
10393
  summary: Simple Raw Message
9809
- value: hello world
10394
+ value: 2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World
9810
10395
  schema:
9811
10396
  type: string
9812
10397
  description: Log to send (JSON format).
@@ -9903,9 +10488,6 @@ paths:
9903
10488
  tags:
9904
10489
  - Logs
9905
10490
  x-codegen-request-body-name: body
9906
- x-menu-order: 1
9907
- x-undo:
9908
- type: safe
9909
10491
  /api/v2/logs/analytics/aggregate:
9910
10492
  post:
9911
10493
  description: The API endpoint to aggregate events into buckets and compute metrics
@@ -9934,9 +10516,6 @@ paths:
9934
10516
  tags:
9935
10517
  - Logs
9936
10518
  x-codegen-request-body-name: body
9937
- x-menu-order: 1
9938
- x-undo:
9939
- type: safe
9940
10519
  /api/v2/logs/config/archive-order:
9941
10520
  get:
9942
10521
  description: 'Get the current order of your archives.
@@ -9965,9 +10544,6 @@ paths:
9965
10544
  summary: Get archive order
9966
10545
  tags:
9967
10546
  - Logs Archives
9968
- x-menu-order: 9
9969
- x-undo:
9970
- type: safe
9971
10547
  put:
9972
10548
  description: 'Update the order of your archives. Since logs are processed sequentially,
9973
10549
  reordering an archive may change
@@ -10018,9 +10594,6 @@ paths:
10018
10594
  tags:
10019
10595
  - Logs Archives
10020
10596
  x-codegen-request-body-name: body
10021
- x-menu-order: 10
10022
- x-undo:
10023
- type: safe
10024
10597
  /api/v2/logs/config/archives:
10025
10598
  get:
10026
10599
  description: Get the list of configured logs archives with their definitions.
@@ -10047,9 +10620,6 @@ paths:
10047
10620
  summary: Get all archives
10048
10621
  tags:
10049
10622
  - Logs Archives
10050
- x-menu-order: 1
10051
- x-undo:
10052
- type: safe
10053
10623
  post:
10054
10624
  description: Create an archive in your organization.
10055
10625
  operationId: CreateLogsArchive
@@ -10085,13 +10655,6 @@ paths:
10085
10655
  tags:
10086
10656
  - Logs Archives
10087
10657
  x-codegen-request-body-name: body
10088
- x-menu-order: 2
10089
- x-undo:
10090
- operationId: DeleteLogsArchive
10091
- parameters:
10092
- - name: archive_id
10093
- source: data.id
10094
- type: unsafe
10095
10658
  /api/v2/logs/config/archives/{archive_id}:
10096
10659
  delete:
10097
10660
  description: Delete a given archive from your organization.
@@ -10124,9 +10687,6 @@ paths:
10124
10687
  summary: Delete an archive
10125
10688
  tags:
10126
10689
  - Logs Archives
10127
- x-menu-order: 5
10128
- x-undo:
10129
- type: idempotent
10130
10690
  get:
10131
10691
  description: Get a specific archive from your organization.
10132
10692
  operationId: GetLogsArchive
@@ -10166,9 +10726,6 @@ paths:
10166
10726
  summary: Get an archive
10167
10727
  tags:
10168
10728
  - Logs Archives
10169
- x-menu-order: 3
10170
- x-undo:
10171
- type: safe
10172
10729
  put:
10173
10730
  description: 'Update a given archive configuration.
10174
10731
 
@@ -10217,9 +10774,6 @@ paths:
10217
10774
  tags:
10218
10775
  - Logs Archives
10219
10776
  x-codegen-request-body-name: body
10220
- x-menu-order: 4
10221
- x-undo:
10222
- type: safe
10223
10777
  /api/v2/logs/config/archives/{archive_id}/readers:
10224
10778
  delete:
10225
10779
  description: Removes a role from an archive. ([Roles API](https://docs.datadoghq.com/api/v2/roles/))
@@ -10259,9 +10813,6 @@ paths:
10259
10813
  tags:
10260
10814
  - Logs Archives
10261
10815
  x-codegen-request-body-name: body
10262
- x-menu-order: 8
10263
- x-undo:
10264
- type: idempotent
10265
10816
  get:
10266
10817
  description: Returns all read roles a given archive is restricted to.
10267
10818
  operationId: ListArchiveReadRoles
@@ -10302,9 +10853,6 @@ paths:
10302
10853
  tags:
10303
10854
  - Logs Archives
10304
10855
  x-codegen-request-body-name: body
10305
- x-menu-order: 6
10306
- x-undo:
10307
- type: safe
10308
10856
  post:
10309
10857
  description: Adds a read role to an archive. ([Roles API](https://docs.datadoghq.com/api/v2/roles/))
10310
10858
  operationId: AddReadRoleToArchive
@@ -10343,9 +10891,6 @@ paths:
10343
10891
  tags:
10344
10892
  - Logs Archives
10345
10893
  x-codegen-request-body-name: body
10346
- x-menu-order: 7
10347
- x-undo:
10348
- type: unsafe
10349
10894
  /api/v2/logs/config/metrics:
10350
10895
  get:
10351
10896
  description: Get the list of configured log-based metrics with their definitions.
@@ -10368,9 +10913,6 @@ paths:
10368
10913
  summary: Get all log-based metrics
10369
10914
  tags:
10370
10915
  - Logs Metrics
10371
- x-menu-order: 1
10372
- x-undo:
10373
- type: safe
10374
10916
  post:
10375
10917
  description: 'Create a metric based on your ingested logs in your organization.
10376
10918
 
@@ -10403,22 +10945,6 @@ paths:
10403
10945
  tags:
10404
10946
  - Logs Metrics
10405
10947
  x-codegen-request-body-name: body
10406
- x-given:
10407
- logs_metric:
10408
- parameters:
10409
- - name: body
10410
- value: "{\n \"data\": {\n \"id\": \"{{ unique }}\",\n \"attributes\":
10411
- {\n \"filter\": {\n \"query\": \"source:{{ unique }}\"\n
10412
- \ },\n \"compute\": {\n \"aggregation_type\": \"count\"\n
10413
- \ }\n },\n \"type\": \"logs_metrics\"\n }\n}"
10414
- step: there is a valid "logs_metric" in the system
10415
- x-menu-order: 2
10416
- x-undo:
10417
- operationId: DeleteLogsMetric
10418
- parameters:
10419
- - name: metric_id
10420
- source: data.id
10421
- type: unsafe
10422
10948
  /api/v2/logs/config/metrics/{metric_id}:
10423
10949
  delete:
10424
10950
  description: Delete a specific log-based metric from your organization.
@@ -10437,9 +10963,6 @@ paths:
10437
10963
  summary: Delete a log-based metric
10438
10964
  tags:
10439
10965
  - Logs Metrics
10440
- x-menu-order: 5
10441
- x-undo:
10442
- type: idempotent
10443
10966
  get:
10444
10967
  description: Get a specific log-based metric from your organization.
10445
10968
  operationId: GetLogsMetric
@@ -10465,9 +10988,6 @@ paths:
10465
10988
  summary: Get a log-based metric
10466
10989
  tags:
10467
10990
  - Logs Metrics
10468
- x-menu-order: 3
10469
- x-undo:
10470
- type: safe
10471
10991
  patch:
10472
10992
  description: 'Update a specific log-based metric from your organization.
10473
10993
 
@@ -10502,9 +11022,6 @@ paths:
10502
11022
  tags:
10503
11023
  - Logs Metrics
10504
11024
  x-codegen-request-body-name: body
10505
- x-menu-order: 4
10506
- x-undo:
10507
- type: idempotent
10508
11025
  /api/v2/logs/events:
10509
11026
  get:
10510
11027
  description: 'List endpoint returns logs that match a log search query.
@@ -10599,14 +11116,11 @@ paths:
10599
11116
  summary: Get a list of logs
10600
11117
  tags:
10601
11118
  - Logs
10602
- x-menu-order: 3
10603
11119
  x-pagination:
10604
11120
  cursorParam: page[cursor]
10605
11121
  cursorPath: meta.page.after
10606
11122
  limitParam: page[limit]
10607
11123
  resultsPath: data
10608
- x-undo:
10609
- type: safe
10610
11124
  /api/v2/logs/events/search:
10611
11125
  post:
10612
11126
  description: 'List endpoint returns logs that match a log search query.
@@ -10651,22 +11165,17 @@ paths:
10651
11165
  tags:
10652
11166
  - Logs
10653
11167
  x-codegen-request-body-name: body
10654
- x-menu-order: 2
10655
11168
  x-pagination:
10656
11169
  cursorParam: body.page.cursor
10657
11170
  cursorPath: meta.page.after
10658
11171
  limitParam: body.page.limit
10659
11172
  resultsPath: data
10660
- x-undo:
10661
- type: safe
10662
11173
  /api/v2/metrics:
10663
11174
  get:
10664
- description: 'Returns all configured count/gauge/rate/distribution metric names
10665
-
10666
- (with additional filters if specified).'
11175
+ description: Returns all metrics (matching additional filters if specified).
10667
11176
  operationId: ListTagConfigurations
10668
11177
  parameters:
10669
- - description: Filter metrics that have configured tags.
11178
+ - description: Filter custom metrics that have configured tags.
10670
11179
  example: true
10671
11180
  in: query
10672
11181
  name: filter[configured]
@@ -10681,7 +11190,7 @@ paths:
10681
11190
  schema:
10682
11191
  description: Tag keys to filter by.
10683
11192
  type: string
10684
- - description: Filter tag configurations by metric type.
11193
+ - description: Filter metrics by metric type.
10685
11194
  in: query
10686
11195
  name: filter[metric_type]
10687
11196
  required: false
@@ -10696,10 +11205,21 @@ paths:
10696
11205
  required: false
10697
11206
  schema:
10698
11207
  type: boolean
11208
+ - description: 'Filter custom metrics that have or have not been queried in
11209
+ the specified window[seconds].
11210
+
11211
+ If no window is provided or the window is less than 2 hours, a default of
11212
+ 2 hours will be applied.'
11213
+ example: true
11214
+ in: query
11215
+ name: filter[queried]
11216
+ required: false
11217
+ schema:
11218
+ type: boolean
10699
11219
  - description: 'Filter metrics that have been submitted with the given tags.
10700
11220
  Supports boolean and wildcard expressions.
10701
11221
 
10702
- Cannot be combined with other filters.'
11222
+ Can only be combined with the filter[queried] filter.'
10703
11223
  example: env IN (staging,test) AND service:web
10704
11224
  in: query
10705
11225
  name: filter[tags]
@@ -10707,9 +11227,9 @@ paths:
10707
11227
  schema:
10708
11228
  type: string
10709
11229
  - description: 'The number of seconds of look back (from now) to apply to a
10710
- filter[tag] query.
11230
+ filter[tag] or filter[queried] query.
10711
11231
 
10712
- Defaults value is 3600 (1 hour), maximum value is 172,800 (2 days).'
11232
+ Defaults value is 3600 (1 hour), maximum value is 1,209,600 (2 weeks).'
10713
11233
  example: 3600
10714
11234
  in: query
10715
11235
  name: window[seconds]
@@ -10747,12 +11267,9 @@ paths:
10747
11267
  appKeyAuth: []
10748
11268
  - AuthZ:
10749
11269
  - metrics_read
10750
- summary: List tag configurations
11270
+ summary: Get a list of metrics
10751
11271
  tags:
10752
11272
  - Metrics
10753
- x-menu-order: 5
10754
- x-undo:
10755
- type: safe
10756
11273
  /api/v2/metrics/config/bulk-tags:
10757
11274
  delete:
10758
11275
  description: 'Delete all custom lists of queryable tag keys for a set of existing
@@ -10807,9 +11324,6 @@ paths:
10807
11324
  tags:
10808
11325
  - Metrics
10809
11326
  x-codegen-request-body-name: body
10810
- x-menu-order: 9
10811
- x-undo:
10812
- type: idempotent
10813
11327
  post:
10814
11328
  description: 'Create and define a list of queryable tag keys for a set of existing
10815
11329
  count, gauge, rate, and distribution metrics.
@@ -10869,13 +11383,63 @@ paths:
10869
11383
  tags:
10870
11384
  - Metrics
10871
11385
  x-codegen-request-body-name: body
10872
- x-menu-order: 8
10873
- x-undo:
10874
- operationId: DeleteBulkTagsMetricsConfiguration
10875
- parameters:
10876
- - name: body
10877
- source: ''
10878
- type: unsafe
11386
+ /api/v2/metrics/{metric_name}/active-configurations:
11387
+ get:
11388
+ description: List tags and aggregations that are actively queried on dashboards
11389
+ and monitors for a given metric name.
11390
+ operationId: ListActiveMetricConfigurations
11391
+ parameters:
11392
+ - $ref: '#/components/parameters/MetricName'
11393
+ - description: 'The number of seconds of look back (from now).
11394
+
11395
+ Default value is 604,800 (1 week), minimum value is 7200 (2 hours), maximum
11396
+ value is 2,630,000 (1 month).'
11397
+ example: 7200
11398
+ in: query
11399
+ name: window[seconds]
11400
+ required: false
11401
+ schema:
11402
+ format: int64
11403
+ type: integer
11404
+ responses:
11405
+ '200':
11406
+ content:
11407
+ application/json:
11408
+ schema:
11409
+ $ref: '#/components/schemas/MetricSuggestedTagsAndAggregationsResponse'
11410
+ description: Success
11411
+ '400':
11412
+ content:
11413
+ application/json:
11414
+ schema:
11415
+ $ref: '#/components/schemas/APIErrorResponse'
11416
+ description: Bad Request
11417
+ '403':
11418
+ content:
11419
+ application/json:
11420
+ schema:
11421
+ $ref: '#/components/schemas/APIErrorResponse'
11422
+ description: Forbidden
11423
+ '404':
11424
+ content:
11425
+ application/json:
11426
+ schema:
11427
+ $ref: '#/components/schemas/APIErrorResponse'
11428
+ description: Not Found
11429
+ '429':
11430
+ content:
11431
+ application/json:
11432
+ schema:
11433
+ $ref: '#/components/schemas/APIErrorResponse'
11434
+ description: Too Many Requests
11435
+ security:
11436
+ - apiKeyAuth: []
11437
+ appKeyAuth: []
11438
+ - AuthZ:
11439
+ - metrics_read
11440
+ summary: List active tags and aggregations
11441
+ tags:
11442
+ - Metrics
10879
11443
  /api/v2/metrics/{metric_name}/all-tags:
10880
11444
  get:
10881
11445
  description: View indexed tag key-value pairs for a given metric name.
@@ -10920,9 +11484,6 @@ paths:
10920
11484
  summary: List tags by metric name
10921
11485
  tags:
10922
11486
  - Metrics
10923
- x-menu-order: 6
10924
- x-undo:
10925
- type: safe
10926
11487
  /api/v2/metrics/{metric_name}/estimate:
10927
11488
  get:
10928
11489
  description: Returns the estimated cardinality for a metric with a given tag,
@@ -11018,12 +11579,9 @@ paths:
11018
11579
  staging_low_urgency: '@slack-points-aggr-stg-ops'
11019
11580
  team: points-aggregation
11020
11581
  team_escalation: '[Points Aggregation] Primary'
11021
- x-menu-order: 10
11022
11582
  x-permission:
11023
11583
  operator: OPEN
11024
11584
  permissions: []
11025
- x-undo:
11026
- type: safe
11027
11585
  /api/v2/metrics/{metric_name}/tags:
11028
11586
  delete:
11029
11587
  description: 'Deletes a metric''s tag configuration. Can only be used with application
@@ -11056,9 +11614,6 @@ paths:
11056
11614
  summary: Delete a tag configuration
11057
11615
  tags:
11058
11616
  - Metrics
11059
- x-menu-order: 4
11060
- x-undo:
11061
- type: idempotent
11062
11617
  get:
11063
11618
  description: Returns the tag configuration for the given metric name.
11064
11619
  operationId: ListTagConfigurationByName
@@ -11097,9 +11652,6 @@ paths:
11097
11652
  summary: List tag configuration by name
11098
11653
  tags:
11099
11654
  - Metrics
11100
- x-menu-order: 2
11101
- x-undo:
11102
- type: safe
11103
11655
  patch:
11104
11656
  description: 'Update the tag configuration of a metric or percentile aggregations
11105
11657
  of a distribution metric or custom aggregations
@@ -11152,9 +11704,6 @@ paths:
11152
11704
  tags:
11153
11705
  - Metrics
11154
11706
  x-codegen-request-body-name: body
11155
- x-menu-order: 3
11156
- x-undo:
11157
- type: idempotent
11158
11707
  post:
11159
11708
  description: 'Create and define a list of queryable tag keys for an existing
11160
11709
  count/gauge/rate/distribution metric.
@@ -11210,24 +11759,6 @@ paths:
11210
11759
  tags:
11211
11760
  - Metrics
11212
11761
  x-codegen-request-body-name: body
11213
- x-given:
11214
- metric_tag_configuration:
11215
- parameters:
11216
- - name: metric_name
11217
- value: '"{{ unique_alnum }}"'
11218
- - name: body
11219
- value: "{\n \"data\": {\n \"attributes\": {\n \"tags\":[\"app\",
11220
- \"datacenter\", \"{{ unique_alnum }}\"],\n \"metric_type\":\"gauge\"\n
11221
- \ },\n \"type\": \"manage_tags\",\n \"id\": \"{{ unique_alnum
11222
- }}\"\n }\n}"
11223
- step: there is a valid "metric_tag_configuration" in the system
11224
- x-menu-order: 1
11225
- x-undo:
11226
- operationId: DeleteTagConfiguration
11227
- parameters:
11228
- - name: metric_name
11229
- source: data.id
11230
- type: unsafe
11231
11762
  /api/v2/metrics/{metric_name}/volumes:
11232
11763
  get:
11233
11764
  description: 'View distinct metrics volumes for the given metric name.
@@ -11276,9 +11807,6 @@ paths:
11276
11807
  summary: List distinct metric volumes by metric name
11277
11808
  tags:
11278
11809
  - Metrics
11279
- x-menu-order: 7
11280
- x-undo:
11281
- type: safe
11282
11810
  /api/v2/permissions:
11283
11811
  get:
11284
11812
  description: Returns a list of all permissions, including name, description,
@@ -11312,13 +11840,6 @@ paths:
11312
11840
  summary: List permissions
11313
11841
  tags:
11314
11842
  - Roles
11315
- x-given:
11316
- permission:
11317
- source: data[0]
11318
- step: there is a valid "permission" in the system
11319
- x-menu-order: 1
11320
- x-undo:
11321
- type: safe
11322
11843
  /api/v2/processes:
11323
11844
  get:
11324
11845
  description: Get all processes for your organization.
@@ -11409,14 +11930,11 @@ paths:
11409
11930
  summary: Get all processes
11410
11931
  tags:
11411
11932
  - Processes
11412
- x-menu-order: 1
11413
11933
  x-pagination:
11414
11934
  cursorParam: page[cursor]
11415
11935
  cursorPath: meta.page.after
11416
11936
  limitParam: page[limit]
11417
11937
  resultsPath: data
11418
- x-undo:
11419
- type: safe
11420
11938
  /api/v2/roles:
11421
11939
  get:
11422
11940
  description: Returns all roles, including their names and their unique identifiers.
@@ -11464,9 +11982,6 @@ paths:
11464
11982
  summary: List roles
11465
11983
  tags:
11466
11984
  - Roles
11467
- x-menu-order: 1
11468
- x-undo:
11469
- type: safe
11470
11985
  post:
11471
11986
  description: Create a new role for your organization.
11472
11987
  operationId: CreateRole
@@ -11506,20 +12021,6 @@ paths:
11506
12021
  tags:
11507
12022
  - Roles
11508
12023
  x-codegen-request-body-name: body
11509
- x-given:
11510
- role:
11511
- parameters:
11512
- - name: body
11513
- value: "{\n \"data\": {\n \"attributes\": {\n \"name\": \"{{
11514
- unique }}\"\n },\n \"type\": \"roles\"\n }\n}"
11515
- step: there is a valid "role" in the system
11516
- x-menu-order: 2
11517
- x-undo:
11518
- operationId: DeleteRole
11519
- parameters:
11520
- - name: role_id
11521
- source: data.id
11522
- type: unsafe
11523
12024
  /api/v2/roles/{role_id}:
11524
12025
  delete:
11525
12026
  description: Disables a role.
@@ -11552,9 +12053,6 @@ paths:
11552
12053
  tags:
11553
12054
  - Roles
11554
12055
  x-codegen-request-body-name: body
11555
- x-menu-order: 5
11556
- x-undo:
11557
- type: idempotent
11558
12056
  get:
11559
12057
  description: "Get a role in the organization specified by the role\u2019s `role_id`."
11560
12058
  operationId: GetRole
@@ -11589,9 +12087,6 @@ paths:
11589
12087
  tags:
11590
12088
  - Roles
11591
12089
  x-codegen-request-body-name: body
11592
- x-menu-order: 3
11593
- x-undo:
11594
- type: safe
11595
12090
  patch:
11596
12091
  description: Edit a role. Can only be used with application keys belonging to
11597
12092
  administrators.
@@ -11646,9 +12141,6 @@ paths:
11646
12141
  tags:
11647
12142
  - Roles
11648
12143
  x-codegen-request-body-name: body
11649
- x-menu-order: 4
11650
- x-undo:
11651
- type: idempotent
11652
12144
  /api/v2/roles/{role_id}/clone:
11653
12145
  post:
11654
12146
  description: Clone an existing role
@@ -11703,14 +12195,7 @@ paths:
11703
12195
  tags:
11704
12196
  - Roles
11705
12197
  x-codegen-request-body-name: body
11706
- x-menu-order: 12
11707
12198
  x-permission: OR(USER_ACCESS_MANAGE)
11708
- x-undo:
11709
- operationId: DeleteRole
11710
- parameters:
11711
- - name: role_id
11712
- source: data.id
11713
- type: unsafe
11714
12199
  /api/v2/roles/{role_id}/permissions:
11715
12200
  delete:
11716
12201
  description: Removes a permission from a role.
@@ -11759,9 +12244,6 @@ paths:
11759
12244
  tags:
11760
12245
  - Roles
11761
12246
  x-codegen-request-body-name: body
11762
- x-menu-order: 8
11763
- x-undo:
11764
- type: idempotent
11765
12247
  get:
11766
12248
  description: Returns a list of all permissions for a single role.
11767
12249
  operationId: ListRolePermissions
@@ -11796,9 +12278,6 @@ paths:
11796
12278
  tags:
11797
12279
  - Roles
11798
12280
  x-codegen-request-body-name: body
11799
- x-menu-order: 6
11800
- x-undo:
11801
- type: safe
11802
12281
  post:
11803
12282
  description: Adds a permission to a role.
11804
12283
  operationId: AddPermissionToRole
@@ -11846,18 +12325,6 @@ paths:
11846
12325
  tags:
11847
12326
  - Roles
11848
12327
  x-codegen-request-body-name: body
11849
- x-given:
11850
- permission_role:
11851
- parameters:
11852
- - name: role_id
11853
- source: role.data.id
11854
- - name: body
11855
- value: "{\n \"data\": {\n \"id\": \"{{ permission.id }}\",\n \"type\":
11856
- \"{{ permission.type }}\"\n }\n}"
11857
- step: the "permission" is granted to the "role"
11858
- x-menu-order: 7
11859
- x-undo:
11860
- type: safe
11861
12328
  /api/v2/roles/{role_id}/users:
11862
12329
  delete:
11863
12330
  description: Removes a user from a role.
@@ -11906,9 +12373,6 @@ paths:
11906
12373
  tags:
11907
12374
  - Roles
11908
12375
  x-codegen-request-body-name: body
11909
- x-menu-order: 11
11910
- x-undo:
11911
- type: idempotent
11912
12376
  get:
11913
12377
  description: Gets all users of a role.
11914
12378
  operationId: ListRoleUsers
@@ -11962,9 +12426,6 @@ paths:
11962
12426
  summary: Get all users of a role
11963
12427
  tags:
11964
12428
  - Roles
11965
- x-menu-order: 9
11966
- x-undo:
11967
- type: safe
11968
12429
  post:
11969
12430
  description: Adds a user to a role.
11970
12431
  operationId: AddUserToRole
@@ -12012,18 +12473,6 @@ paths:
12012
12473
  tags:
12013
12474
  - Roles
12014
12475
  x-codegen-request-body-name: body
12015
- x-given:
12016
- permission_role:
12017
- parameters:
12018
- - name: role_id
12019
- source: role.data.id
12020
- - name: body
12021
- value: "{\n \"data\": {\n \"id\": \"{{ user.data.id }}\",\n \"type\":
12022
- \"{{ user.data.type }}\"\n }\n}"
12023
- step: the "user" has the "role"
12024
- x-menu-order: 10
12025
- x-undo:
12026
- type: safe
12027
12476
  /api/v2/rum/analytics/aggregate:
12028
12477
  post:
12029
12478
  description: The API endpoint to aggregate RUM events into buckets of computed
@@ -12056,9 +12505,132 @@ paths:
12056
12505
  tags:
12057
12506
  - RUM
12058
12507
  x-codegen-request-body-name: body
12059
- x-menu-order: 3
12060
- x-undo:
12061
- type: safe
12508
+ /api/v2/rum/applications:
12509
+ get:
12510
+ description: List all the RUM applications in your organization.
12511
+ operationId: GetRUMApplications
12512
+ responses:
12513
+ '200':
12514
+ content:
12515
+ application/json:
12516
+ schema:
12517
+ $ref: '#/components/schemas/RUMApplicationsResponse'
12518
+ description: OK
12519
+ '404':
12520
+ $ref: '#/components/responses/NotFoundResponse'
12521
+ '429':
12522
+ $ref: '#/components/responses/TooManyRequestsResponse'
12523
+ summary: List all the RUM applications
12524
+ tags:
12525
+ - RUM
12526
+ post:
12527
+ description: Create a new RUM application in your organization.
12528
+ operationId: CreateRUMApplication
12529
+ requestBody:
12530
+ content:
12531
+ application/json:
12532
+ schema:
12533
+ $ref: '#/components/schemas/RUMApplicationCreateRequest'
12534
+ required: true
12535
+ responses:
12536
+ '200':
12537
+ content:
12538
+ application/json:
12539
+ schema:
12540
+ $ref: '#/components/schemas/RUMApplicationResponse'
12541
+ description: OK
12542
+ '400':
12543
+ $ref: '#/components/responses/BadRequestResponse'
12544
+ '429':
12545
+ $ref: '#/components/responses/TooManyRequestsResponse'
12546
+ summary: Create a new RUM application
12547
+ tags:
12548
+ - RUM
12549
+ x-codegen-request-body-name: body
12550
+ /api/v2/rum/applications/{id}:
12551
+ delete:
12552
+ description: Delete an existing RUM application in your organization.
12553
+ operationId: DeleteRUMApplication
12554
+ parameters:
12555
+ - description: RUM application ID.
12556
+ in: path
12557
+ name: id
12558
+ required: true
12559
+ schema:
12560
+ type: string
12561
+ responses:
12562
+ '204':
12563
+ description: No Content
12564
+ '404':
12565
+ $ref: '#/components/responses/NotFoundResponse'
12566
+ '429':
12567
+ $ref: '#/components/responses/TooManyRequestsResponse'
12568
+ summary: Delete a RUM application
12569
+ tags:
12570
+ - RUM
12571
+ get:
12572
+ description: Get the RUM application with given ID in your organization.
12573
+ operationId: GetRUMApplication
12574
+ parameters:
12575
+ - description: RUM application ID.
12576
+ in: path
12577
+ name: id
12578
+ required: true
12579
+ schema:
12580
+ type: string
12581
+ responses:
12582
+ '200':
12583
+ content:
12584
+ application/json:
12585
+ schema:
12586
+ $ref: '#/components/schemas/RUMApplicationResponse'
12587
+ description: OK
12588
+ '404':
12589
+ $ref: '#/components/responses/NotFoundResponse'
12590
+ '429':
12591
+ $ref: '#/components/responses/TooManyRequestsResponse'
12592
+ summary: Get a RUM application
12593
+ tags:
12594
+ - RUM
12595
+ patch:
12596
+ description: Update the RUM application with given ID in your organization.
12597
+ operationId: UpdateRUMApplication
12598
+ parameters:
12599
+ - description: RUM application ID.
12600
+ in: path
12601
+ name: id
12602
+ required: true
12603
+ schema:
12604
+ type: string
12605
+ requestBody:
12606
+ content:
12607
+ application/json:
12608
+ schema:
12609
+ $ref: '#/components/schemas/RUMApplicationUpdateRequest'
12610
+ required: true
12611
+ responses:
12612
+ '200':
12613
+ content:
12614
+ application/json:
12615
+ schema:
12616
+ $ref: '#/components/schemas/RUMApplicationResponse'
12617
+ description: OK
12618
+ '400':
12619
+ $ref: '#/components/responses/BadRequestResponse'
12620
+ '404':
12621
+ $ref: '#/components/responses/NotFoundResponse'
12622
+ '422':
12623
+ content:
12624
+ application/json:
12625
+ schema:
12626
+ $ref: '#/components/schemas/APIErrorResponse'
12627
+ description: Unprocessable Entity.
12628
+ '429':
12629
+ $ref: '#/components/responses/TooManyRequestsResponse'
12630
+ summary: Update a RUM application
12631
+ tags:
12632
+ - RUM
12633
+ x-codegen-request-body-name: body
12062
12634
  /api/v2/rum/events:
12063
12635
  get:
12064
12636
  description: 'List endpoint returns events that match a RUM search query.
@@ -12139,14 +12711,11 @@ paths:
12139
12711
  summary: Get a list of RUM events
12140
12712
  tags:
12141
12713
  - RUM
12142
- x-menu-order: 2
12143
12714
  x-pagination:
12144
12715
  cursorParam: page[cursor]
12145
12716
  cursorPath: meta.page.after
12146
12717
  limitParam: page[limit]
12147
12718
  resultsPath: data
12148
- x-undo:
12149
- type: safe
12150
12719
  /api/v2/rum/events/search:
12151
12720
  post:
12152
12721
  description: 'List endpoint returns RUM events that match a RUM search query.
@@ -12186,14 +12755,11 @@ paths:
12186
12755
  tags:
12187
12756
  - RUM
12188
12757
  x-codegen-request-body-name: body
12189
- x-menu-order: 1
12190
12758
  x-pagination:
12191
12759
  cursorParam: body.page.cursor
12192
12760
  cursorPath: meta.page.after
12193
12761
  limitParam: body.page.limit
12194
12762
  resultsPath: data
12195
- x-undo:
12196
- type: safe
12197
12763
  /api/v2/saml_configurations/idp_metadata:
12198
12764
  post:
12199
12765
  description: 'Endpoint for uploading IdP metadata for SAML setup.
@@ -12228,9 +12794,6 @@ paths:
12228
12794
  tags:
12229
12795
  - Organizations
12230
12796
  x-codegen-request-body-name: body
12231
- x-menu-order: 1
12232
- x-undo:
12233
- type: idempotent
12234
12797
  /api/v2/security/cloud_workload/policy/download:
12235
12798
  get:
12236
12799
  description: 'The download endpoint generates a Cloud Workload Security policy
@@ -12256,9 +12819,6 @@ paths:
12256
12819
  summary: Get the latest Cloud Workload Security policy
12257
12820
  tags:
12258
12821
  - Cloud Workload Security
12259
- x-menu-order: 1
12260
- x-undo:
12261
- type: safe
12262
12822
  /api/v2/security_monitoring/cloud_workload_security/agent_rules:
12263
12823
  get:
12264
12824
  description: Get the list of Agent rules.
@@ -12277,9 +12837,6 @@ paths:
12277
12837
  summary: Get all Cloud Workload Security Agent rules
12278
12838
  tags:
12279
12839
  - Cloud Workload Security
12280
- x-menu-order: 3
12281
- x-undo:
12282
- type: safe
12283
12840
  post:
12284
12841
  description: Create a new Agent rule with the given parameters.
12285
12842
  operationId: CreateCloudWorkloadSecurityAgentRule
@@ -12309,22 +12866,6 @@ paths:
12309
12866
  tags:
12310
12867
  - Cloud Workload Security
12311
12868
  x-codegen-request-body-name: body
12312
- x-given:
12313
- agent_rule:
12314
- parameters:
12315
- - name: body
12316
- value: "{\n \"data\": {\n \"type\": \"agent_rule\",\n \"attributes\":
12317
- {\n \"name\": \"{{ unique_lower_alnum }}\",\n \"description\":
12318
- \"My Agent rule\",\n \"expression\": \"exec.file.name == \\\"sh\\\"\",\n
12319
- \ \"enabled\": true\n }\n }\n}"
12320
- step: there is a valid "agent_rule" in the system
12321
- x-menu-order: 4
12322
- x-undo:
12323
- operationId: DeleteCloudWorkloadSecurityAgentRule
12324
- parameters:
12325
- - name: agent_rule_id
12326
- source: data.id
12327
- type: unsafe
12328
12869
  /api/v2/security_monitoring/cloud_workload_security/agent_rules/{agent_rule_id}:
12329
12870
  delete:
12330
12871
  description: Delete a specific Agent rule.
@@ -12343,9 +12884,6 @@ paths:
12343
12884
  summary: Delete a Cloud Workload Security Agent rule
12344
12885
  tags:
12345
12886
  - Cloud Workload Security
12346
- x-menu-order: 6
12347
- x-undo:
12348
- type: idempotent
12349
12887
  get:
12350
12888
  description: Get the details of a specific Agent rule.
12351
12889
  operationId: GetCloudWorkloadSecurityAgentRule
@@ -12367,9 +12905,6 @@ paths:
12367
12905
  summary: Get a Cloud Workload Security Agent rule
12368
12906
  tags:
12369
12907
  - Cloud Workload Security
12370
- x-menu-order: 2
12371
- x-undo:
12372
- type: safe
12373
12908
  patch:
12374
12909
  description: 'Update a specific Agent rule.
12375
12910
 
@@ -12405,9 +12940,6 @@ paths:
12405
12940
  tags:
12406
12941
  - Cloud Workload Security
12407
12942
  x-codegen-request-body-name: body
12408
- x-menu-order: 5
12409
- x-undo:
12410
- type: idempotent
12411
12943
  /api/v2/security_monitoring/configuration/security_filters:
12412
12944
  get:
12413
12945
  description: Get the list of configured security filters with their definitions.
@@ -12431,8 +12963,6 @@ paths:
12431
12963
  summary: Get all security filters
12432
12964
  tags:
12433
12965
  - Security Monitoring
12434
- x-undo:
12435
- type: safe
12436
12966
  post:
12437
12967
  description: 'Create a security filter.
12438
12968
 
@@ -12472,23 +13002,6 @@ paths:
12472
13002
  tags:
12473
13003
  - Security Monitoring
12474
13004
  x-codegen-request-body-name: body
12475
- x-given:
12476
- security_filter:
12477
- parameters:
12478
- - name: body
12479
- value: "{\n \"data\": {\n \"type\": \"security_filters\",\n \"attributes\":
12480
- {\n \"name\": \"{{ unique }}\",\n \"query\": \"service:{{
12481
- unique_alnum }}\",\n \"exclusion_filters\":[\n {\n \"name\":
12482
- \"Exclude logs from staging\",\n \"query\": \"source:staging\"\n
12483
- \ }\n ],\n \"filtered_data_type\":\"logs\",\n \"is_enabled\":
12484
- true\n }\n }\n}"
12485
- step: there is a valid "security_filter" in the system
12486
- x-undo:
12487
- operationId: DeleteSecurityFilter
12488
- parameters:
12489
- - name: security_filter_id
12490
- source: data.id
12491
- type: unsafe
12492
13005
  /api/v2/security_monitoring/configuration/security_filters/{security_filter_id}:
12493
13006
  delete:
12494
13007
  description: Delete a specific security filter.
@@ -12512,8 +13025,6 @@ paths:
12512
13025
  summary: Delete a security filter
12513
13026
  tags:
12514
13027
  - Security Monitoring
12515
- x-undo:
12516
- type: idempotent
12517
13028
  get:
12518
13029
  description: 'Get the details of a specific security filter.
12519
13030
 
@@ -12545,8 +13056,6 @@ paths:
12545
13056
  summary: Get a security filter
12546
13057
  tags:
12547
13058
  - Security Monitoring
12548
- x-undo:
12549
- type: safe
12550
13059
  patch:
12551
13060
  description: 'Update a specific security filter.
12552
13061
 
@@ -12587,8 +13096,6 @@ paths:
12587
13096
  tags:
12588
13097
  - Security Monitoring
12589
13098
  x-codegen-request-body-name: body
12590
- x-undo:
12591
- type: idempotent
12592
13099
  /api/v2/security_monitoring/rules:
12593
13100
  get:
12594
13101
  description: List rules.
@@ -12615,9 +13122,6 @@ paths:
12615
13122
  summary: List rules
12616
13123
  tags:
12617
13124
  - Security Monitoring
12618
- x-menu-order: 1
12619
- x-undo:
12620
- type: safe
12621
13125
  post:
12622
13126
  description: Create a detection rule.
12623
13127
  operationId: CreateSecurityMonitoringRule
@@ -12649,26 +13153,6 @@ paths:
12649
13153
  tags:
12650
13154
  - Security Monitoring
12651
13155
  x-codegen-request-body-name: body
12652
- x-given:
12653
- security_rule:
12654
- parameters:
12655
- - name: body
12656
- value: "{\n \"name\": \"{{ unique }}\",\n \"queries\": [{\n \"query\":
12657
- \"@test:true\",\n \"aggregation\": \"count\",\n \"groupByFields\":
12658
- [],\n \"distinctFields\": [],\n \"metric\": \"\"\n }],\n \"filters\":
12659
- [],\n \"cases\": [{\n \"name\": \"\",\n \"status\": \"info\",\n
12660
- \ \"condition\": \"a > 0\",\n \"notifications\": []\n }],\n \"options\":
12661
- {\n \"evaluationWindow\": 900,\n \"keepAlive\": 3600,\n \"maxSignalDuration\":
12662
- 86400\n },\n \"message\": \"Test rule\",\n \"tags\": [],\n \"isEnabled\":
12663
- true,\n \"type\": \"log_detection\"\n}"
12664
- step: there is a valid "security_rule" in the system
12665
- x-menu-order: 2
12666
- x-undo:
12667
- operationId: DeleteSecurityMonitoringRule
12668
- parameters:
12669
- - name: rule_id
12670
- source: id
12671
- type: unsafe
12672
13156
  /api/v2/security_monitoring/rules/{rule_id}:
12673
13157
  delete:
12674
13158
  description: Delete an existing rule. Default rules cannot be deleted.
@@ -12692,9 +13176,6 @@ paths:
12692
13176
  summary: Delete an existing rule
12693
13177
  tags:
12694
13178
  - Security Monitoring
12695
- x-menu-order: 5
12696
- x-undo:
12697
- type: idempotent
12698
13179
  get:
12699
13180
  description: Get a rule's details.
12700
13181
  operationId: GetSecurityMonitoringRule
@@ -12719,9 +13200,6 @@ paths:
12719
13200
  summary: Get a rule's details
12720
13201
  tags:
12721
13202
  - Security Monitoring
12722
- x-menu-order: 3
12723
- x-undo:
12724
- type: safe
12725
13203
  put:
12726
13204
  description: 'Update an existing rule. When updating `cases`, `queries` or `options`,
12727
13205
  the whole field
@@ -12765,9 +13243,6 @@ paths:
12765
13243
  tags:
12766
13244
  - Security Monitoring
12767
13245
  x-codegen-request-body-name: body
12768
- x-menu-order: 4
12769
- x-undo:
12770
- type: idempotent
12771
13246
  /api/v2/security_monitoring/signals:
12772
13247
  get:
12773
13248
  description: 'The list endpoint returns security signals that match a search
@@ -12846,14 +13321,11 @@ paths:
12846
13321
  summary: Get a quick list of security signals
12847
13322
  tags:
12848
13323
  - Security Monitoring
12849
- x-menu-order: 7
12850
13324
  x-pagination:
12851
13325
  cursorParam: page[cursor]
12852
13326
  cursorPath: meta.page.after
12853
13327
  limitParam: page[limit]
12854
13328
  resultsPath: data
12855
- x-undo:
12856
- type: safe
12857
13329
  /api/v2/security_monitoring/signals/search:
12858
13330
  post:
12859
13331
  description: 'Returns security signals that match a search query.
@@ -12890,14 +13362,36 @@ paths:
12890
13362
  tags:
12891
13363
  - Security Monitoring
12892
13364
  x-codegen-request-body-name: body
12893
- x-menu-order: 6
12894
13365
  x-pagination:
12895
13366
  cursorParam: body.page.cursor
12896
13367
  cursorPath: meta.page.after
12897
13368
  limitParam: body.page.limit
12898
13369
  resultsPath: data
12899
- x-undo:
12900
- type: safe
13370
+ /api/v2/security_monitoring/signals/{signal_id}:
13371
+ get:
13372
+ description: Get a signal's details.
13373
+ operationId: GetSecurityMonitoringSignal
13374
+ parameters:
13375
+ - $ref: '#/components/parameters/SignalID'
13376
+ responses:
13377
+ '200':
13378
+ content:
13379
+ application/json:
13380
+ schema:
13381
+ $ref: '#/components/schemas/SecurityMonitoringSignal'
13382
+ description: OK
13383
+ '404':
13384
+ $ref: '#/components/responses/NotFoundResponse'
13385
+ '429':
13386
+ $ref: '#/components/responses/TooManyRequestsResponse'
13387
+ security:
13388
+ - apiKeyAuth: []
13389
+ appKeyAuth: []
13390
+ - AuthZ:
13391
+ - security_monitoring_rules_read
13392
+ summary: Get a signal's details
13393
+ tags:
13394
+ - Security Monitoring
12901
13395
  /api/v2/security_monitoring/signals/{signal_id}/assignee:
12902
13396
  patch:
12903
13397
  description: Modify the triage assignee of a security signal.
@@ -12938,17 +13432,10 @@ paths:
12938
13432
  description: Not Found
12939
13433
  '429':
12940
13434
  $ref: '#/components/responses/TooManyRequestsResponse'
12941
- security:
12942
- - apiKeyAuth: []
12943
- appKeyAuth: []
12944
- - AuthZ:
12945
- - security_monitoring_signals_write
12946
13435
  summary: Modify the triage assignee of a security signal
12947
13436
  tags:
12948
13437
  - Security Monitoring
12949
13438
  x-codegen-request-body-name: body
12950
- x-undo:
12951
- type: idempotent
12952
13439
  /api/v2/security_monitoring/signals/{signal_id}/incidents:
12953
13440
  patch:
12954
13441
  description: Change the related incidents for a security signal.
@@ -12989,17 +13476,10 @@ paths:
12989
13476
  description: Not Found
12990
13477
  '429':
12991
13478
  $ref: '#/components/responses/TooManyRequestsResponse'
12992
- security:
12993
- - apiKeyAuth: []
12994
- appKeyAuth: []
12995
- - AuthZ:
12996
- - security_monitoring_signals_write
12997
13479
  summary: Change the related incidents of a security signal
12998
13480
  tags:
12999
13481
  - Security Monitoring
13000
13482
  x-codegen-request-body-name: body
13001
- x-undo:
13002
- type: idempotent
13003
13483
  /api/v2/security_monitoring/signals/{signal_id}/state:
13004
13484
  patch:
13005
13485
  description: Change the triage state of a security signal.
@@ -13040,17 +13520,10 @@ paths:
13040
13520
  description: Not Found
13041
13521
  '429':
13042
13522
  $ref: '#/components/responses/TooManyRequestsResponse'
13043
- security:
13044
- - apiKeyAuth: []
13045
- appKeyAuth: []
13046
- - AuthZ:
13047
- - security_monitoring_signals_write
13048
13523
  summary: Change the triage state of a security signal
13049
13524
  tags:
13050
13525
  - Security Monitoring
13051
13526
  x-codegen-request-body-name: body
13052
- x-undo:
13053
- type: idempotent
13054
13527
  /api/v2/series:
13055
13528
  post:
13056
13529
  description: "The metrics end-point allows you to post time-series data that
@@ -13122,9 +13595,6 @@ paths:
13122
13595
  tags:
13123
13596
  - Metrics
13124
13597
  x-codegen-request-body-name: body
13125
- x-menu-order: 1
13126
- x-undo:
13127
- type: safe
13128
13598
  /api/v2/service_accounts:
13129
13599
  post:
13130
13600
  description: Create a service account for your organization.
@@ -13160,21 +13630,6 @@ paths:
13160
13630
  tags:
13161
13631
  - Users
13162
13632
  x-codegen-request-body-name: body
13163
- x-given:
13164
- service_account_user:
13165
- parameters:
13166
- - name: body
13167
- value: "{\n \"data\": {\n \"attributes\": {\n \"email\": \"{{
13168
- unique }}@datadoghq.com\",\n \"title\": \"user title\",\n \"service_account\":
13169
- true\n },\n \"type\": \"users\"\n }\n}"
13170
- step: there is a valid "service_account_user" in the system
13171
- x-menu-order: 1
13172
- x-undo:
13173
- operationId: DisableUser
13174
- parameters:
13175
- - name: user_id
13176
- source: data.id
13177
- type: unsafe
13178
13633
  /api/v2/service_accounts/{service_account_id}/application_keys:
13179
13634
  get:
13180
13635
  description: List all application keys available for this service account.
@@ -13217,8 +13672,6 @@ paths:
13217
13672
  summary: List application keys for this service account
13218
13673
  tags:
13219
13674
  - Service Accounts
13220
- x-undo:
13221
- type: safe
13222
13675
  post:
13223
13676
  description: Create an application key for this service account.
13224
13677
  operationId: CreateServiceAccountApplicationKey
@@ -13255,23 +13708,6 @@ paths:
13255
13708
  tags:
13256
13709
  - Service Accounts
13257
13710
  x-codegen-request-body-name: body
13258
- x-given:
13259
- service_account_application_key:
13260
- parameters:
13261
- - name: service_account_id
13262
- value: '"{{ service_account_user.data.id }}"'
13263
- - name: body
13264
- value: "{\n \"data\": {\n \"attributes\": {\n \"name\": \"{{
13265
- unique }}\"\n },\n \"type\": \"application_keys\"\n }\n}"
13266
- step: there is a valid "service_account_application_key" for "service_account_user"
13267
- x-undo:
13268
- operationId: DeleteServiceAccountApplicationKey
13269
- parameters:
13270
- - name: app_key_id
13271
- source: data.id
13272
- - name: service_account_id
13273
- source: data.relationships.owned_by.data.id
13274
- type: unsafe
13275
13711
  /api/v2/service_accounts/{service_account_id}/application_keys/{app_key_id}:
13276
13712
  delete:
13277
13713
  description: Delete an application key owned by this service account.
@@ -13299,9 +13735,6 @@ paths:
13299
13735
  summary: Delete an application key for this service account
13300
13736
  tags:
13301
13737
  - Service Accounts
13302
- x-menu-order: 3
13303
- x-undo:
13304
- type: idempotent
13305
13738
  get:
13306
13739
  description: Get an application key owned by this service account.
13307
13740
  operationId: GetServiceAccountApplicationKey
@@ -13332,9 +13765,6 @@ paths:
13332
13765
  summary: Get one application key for this service account
13333
13766
  tags:
13334
13767
  - Service Accounts
13335
- x-menu-order: 1
13336
- x-undo:
13337
- type: safe
13338
13768
  patch:
13339
13769
  description: Edit an application key owned by this service account.
13340
13770
  operationId: UpdateServiceAccountApplicationKey
@@ -13378,9 +13808,6 @@ paths:
13378
13808
  tags:
13379
13809
  - Service Accounts
13380
13810
  x-codegen-request-body-name: body
13381
- x-menu-order: 2
13382
- x-undo:
13383
- type: idempotent
13384
13811
  /api/v2/services:
13385
13812
  get:
13386
13813
  description: Get all incident services uploaded for the requesting user's organization.
@@ -13417,8 +13844,6 @@ paths:
13417
13844
  summary: Get a list of all incident services
13418
13845
  tags:
13419
13846
  - Incident Services
13420
- x-undo:
13421
- type: safe
13422
13847
  x-unstable: '**Note**: This endpoint is in public beta.
13423
13848
 
13424
13849
  If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
@@ -13458,19 +13883,6 @@ paths:
13458
13883
  tags:
13459
13884
  - Incident Services
13460
13885
  x-codegen-request-body-name: body
13461
- x-given:
13462
- service:
13463
- parameters:
13464
- - name: body
13465
- value: "{\n \"data\": {\n \"attributes\": {\n \"name\": \"{{
13466
- unique }}\"\n },\n \"type\": \"services\"\n }\n}"
13467
- step: there is a valid "service" in the system
13468
- x-undo:
13469
- operationId: DeleteIncidentService
13470
- parameters:
13471
- - name: service_id
13472
- source: data.id
13473
- type: unsafe
13474
13886
  x-unstable: '**Note**: This endpoint is in public beta.
13475
13887
 
13476
13888
  If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
@@ -13501,8 +13913,6 @@ paths:
13501
13913
  summary: Delete an existing incident service
13502
13914
  tags:
13503
13915
  - Incident Services
13504
- x-undo:
13505
- type: idempotent
13506
13916
  x-unstable: '**Note**: This endpoint is in public beta.
13507
13917
 
13508
13918
  If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
@@ -13540,8 +13950,6 @@ paths:
13540
13950
  summary: Get details of an incident service
13541
13951
  tags:
13542
13952
  - Incident Services
13543
- x-undo:
13544
- type: safe
13545
13953
  x-unstable: '**Note**: This endpoint is in public beta.
13546
13954
 
13547
13955
  If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
@@ -13584,8 +13992,6 @@ paths:
13584
13992
  tags:
13585
13993
  - Incident Services
13586
13994
  x-codegen-request-body-name: body
13587
- x-undo:
13588
- type: idempotent
13589
13995
  x-unstable: '**Note**: This endpoint is in public beta.
13590
13996
 
13591
13997
  If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
@@ -13625,8 +14031,6 @@ paths:
13625
14031
  summary: Get a list of all incident teams
13626
14032
  tags:
13627
14033
  - Incident Teams
13628
- x-undo:
13629
- type: safe
13630
14034
  x-unstable: '**Note**: This endpoint is in public beta.
13631
14035
 
13632
14036
  If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
@@ -13666,19 +14070,6 @@ paths:
13666
14070
  tags:
13667
14071
  - Incident Teams
13668
14072
  x-codegen-request-body-name: body
13669
- x-given:
13670
- team:
13671
- parameters:
13672
- - name: body
13673
- value: "{\n \"data\": {\n \"attributes\": {\n \"name\": \"{{
13674
- unique }}\"\n },\n \"type\": \"teams\"\n }\n}"
13675
- step: there is a valid "team" in the system
13676
- x-undo:
13677
- operationId: DeleteIncidentTeam
13678
- parameters:
13679
- - name: team_id
13680
- source: data.id
13681
- type: unsafe
13682
14073
  x-unstable: '**Note**: This endpoint is in public beta.
13683
14074
 
13684
14075
  If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
@@ -13709,8 +14100,6 @@ paths:
13709
14100
  summary: Delete an existing incident team
13710
14101
  tags:
13711
14102
  - Incident Teams
13712
- x-undo:
13713
- type: idempotent
13714
14103
  x-unstable: '**Note**: This endpoint is in public beta.
13715
14104
 
13716
14105
  If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
@@ -13748,8 +14137,6 @@ paths:
13748
14137
  summary: Get details of an incident team
13749
14138
  tags:
13750
14139
  - Incident Teams
13751
- x-undo:
13752
- type: safe
13753
14140
  x-unstable: '**Note**: This endpoint is in public beta.
13754
14141
 
13755
14142
  If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
@@ -13792,8 +14179,6 @@ paths:
13792
14179
  tags:
13793
14180
  - Incident Teams
13794
14181
  x-codegen-request-body-name: body
13795
- x-undo:
13796
- type: idempotent
13797
14182
  x-unstable: '**Note**: This endpoint is in public beta.
13798
14183
 
13799
14184
  If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
@@ -13856,13 +14241,19 @@ paths:
13856
14241
  summary: Get hourly usage for application security
13857
14242
  tags:
13858
14243
  - Usage Metering
13859
- x-menu-order: 37
13860
- x-undo:
13861
- type: safe
13862
14244
  /api/v2/usage/cost_by_org:
13863
14245
  get:
13864
- description: Get cost across multi-org account. Cost by org data for a given
13865
- month becomes available no later than the 16th of the following month.
14246
+ deprecated: true
14247
+ description: 'Get cost across multi-org account.
14248
+
14249
+ Cost by org data for a given month becomes available no later than the 16th
14250
+ of the following month.
14251
+
14252
+ **Note:** This endpoint has been deprecated. Please use the new endpoint
14253
+
14254
+ [`/historical_cost`](https://docs.datadoghq.com/api/latest/usage-metering/#get-historical-cost-across-your-account)
14255
+
14256
+ instead.'
13866
14257
  operationId: GetCostByOrg
13867
14258
  parameters:
13868
14259
  - description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]`
@@ -13914,22 +14305,21 @@ paths:
13914
14305
  summary: Get cost across multi-org account
13915
14306
  tags:
13916
14307
  - Usage Metering
13917
- x-menu-order: 5
13918
- x-undo:
13919
- type: safe
13920
14308
  /api/v2/usage/estimated_cost:
13921
14309
  get:
13922
14310
  description: 'Get estimated cost across multi-org and single root-org accounts.
13923
14311
 
13924
14312
  Estimated cost data is only available for the current month and previous month.
13925
- To access historical costs prior to this, use the /cost_by_org endpoint.'
14313
+
14314
+ To access historical costs prior to this, use the `/historical_cost` endpoint.'
13926
14315
  operationId: GetEstimatedCostByOrg
13927
14316
  parameters:
13928
14317
  - description: String to specify whether cost is broken down at a parent-org
13929
- level or at the sub-org level. Currently, only the 'sub-org' view is supported.
14318
+ level or at the sub-org level. Available views are `summary` and `sub-org`.
14319
+ Defaults to `summary`.
13930
14320
  in: query
13931
14321
  name: view
13932
- required: true
14322
+ required: false
13933
14323
  schema:
13934
14324
  type: string
13935
14325
  - description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]`
@@ -14001,13 +14391,71 @@ paths:
14001
14391
  summary: Get estimated cost across your account
14002
14392
  tags:
14003
14393
  - Usage Metering
14004
- x-menu-order: 39
14005
- x-undo:
14006
- type: safe
14007
- x-unstable: '**Note**: This endpoint is in public beta.
14394
+ /api/v2/usage/historical_cost:
14395
+ get:
14396
+ description: 'Get historical cost across multi-org and single root-org accounts.
14008
14397
 
14009
- Only the sub-org view is available currently, the summary view will be released
14010
- at a later date.'
14398
+ Cost data for a given month becomes available no later than the 16th of the
14399
+ following month.'
14400
+ operationId: GetHistoricalCostByOrg
14401
+ parameters:
14402
+ - description: String to specify whether cost is broken down at a parent-org
14403
+ level or at the sub-org level. Available views are `summary` and `sub-org`. Defaults
14404
+ to `summary`.
14405
+ in: query
14406
+ name: view
14407
+ required: false
14408
+ schema:
14409
+ type: string
14410
+ - description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]`
14411
+ for cost beginning this month.'
14412
+ in: query
14413
+ name: start_month
14414
+ required: true
14415
+ schema:
14416
+ format: date-time
14417
+ type: string
14418
+ - description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]`
14419
+ for cost ending this month.'
14420
+ in: query
14421
+ name: end_month
14422
+ required: false
14423
+ schema:
14424
+ format: date-time
14425
+ type: string
14426
+ responses:
14427
+ '200':
14428
+ content:
14429
+ application/json;datetime-format=rfc3339:
14430
+ schema:
14431
+ $ref: '#/components/schemas/CostByOrgResponse'
14432
+ description: OK
14433
+ '400':
14434
+ content:
14435
+ application/json;datetime-format=rfc3339:
14436
+ schema:
14437
+ $ref: '#/components/schemas/APIErrorResponse'
14438
+ description: Bad Request
14439
+ '403':
14440
+ content:
14441
+ application/json;datetime-format=rfc3339:
14442
+ schema:
14443
+ $ref: '#/components/schemas/APIErrorResponse'
14444
+ description: Forbidden - User is not authorized
14445
+ '429':
14446
+ content:
14447
+ application/json;datetime-format=rfc3339:
14448
+ schema:
14449
+ $ref: '#/components/schemas/APIErrorResponse'
14450
+ description: Too many requests
14451
+ security:
14452
+ - apiKeyAuth: []
14453
+ appKeyAuth: []
14454
+ - AuthZ:
14455
+ - usage_read
14456
+ summary: Get historical cost across your account
14457
+ tags:
14458
+ - Usage Metering
14011
14459
  /api/v2/usage/hourly_usage:
14012
14460
  get:
14013
14461
  description: Get hourly usage by product family
@@ -14119,9 +14567,6 @@ paths:
14119
14567
  summary: Get hourly usage by product family
14120
14568
  tags:
14121
14569
  - Usage Metering
14122
- x-menu-order: 1
14123
- x-undo:
14124
- type: safe
14125
14570
  /api/v2/usage/lambda_traced_invocations:
14126
14571
  get:
14127
14572
  description: 'Get hourly usage for lambda traced invocations.
@@ -14181,9 +14626,6 @@ paths:
14181
14626
  summary: Get hourly usage for lambda traced invocations
14182
14627
  tags:
14183
14628
  - Usage Metering
14184
- x-menu-order: 36
14185
- x-undo:
14186
- type: safe
14187
14629
  /api/v2/usage/observability_pipelines:
14188
14630
  get:
14189
14631
  description: 'Get hourly usage for observability pipelines.
@@ -14243,9 +14685,6 @@ paths:
14243
14685
  summary: Get hourly usage for observability pipelines
14244
14686
  tags:
14245
14687
  - Usage Metering
14246
- x-menu-order: 38
14247
- x-undo:
14248
- type: safe
14249
14688
  /api/v2/user_invitations:
14250
14689
  post:
14251
14690
  description: Sends emails to one or more users inviting them to join the organization.
@@ -14286,18 +14725,6 @@ paths:
14286
14725
  tags:
14287
14726
  - Users
14288
14727
  x-codegen-request-body-name: body
14289
- x-given:
14290
- user_invitation:
14291
- parameters:
14292
- - name: body
14293
- value: "{\n \"data\": [\n {\n \"relationships\": {\"user\": {\"data\":
14294
- {\n \"id\": \"{{ user.data.id }}\",\n \"type\": \"{{ user.data.type
14295
- }}\"\n }}},\n \"type\": \"user_invitations\"\n }\n ]\n}"
14296
- source: data[0]
14297
- step: the "user" has a "user_invitation"
14298
- x-menu-order: 8
14299
- x-undo:
14300
- type: safe
14301
14728
  /api/v2/user_invitations/{user_invitation_uuid}:
14302
14729
  get:
14303
14730
  description: Returns a single user invitation by its UUID.
@@ -14340,9 +14767,6 @@ paths:
14340
14767
  tags:
14341
14768
  - Users
14342
14769
  x-codegen-request-body-name: body
14343
- x-menu-order: 9
14344
- x-undo:
14345
- type: safe
14346
14770
  /api/v2/users:
14347
14771
  get:
14348
14772
  description: 'Get the list of all users in the organization. This list includes
@@ -14419,9 +14843,6 @@ paths:
14419
14843
  tags:
14420
14844
  - Users
14421
14845
  x-codegen-request-body-name: body
14422
- x-menu-order: 1
14423
- x-undo:
14424
- type: safe
14425
14846
  post:
14426
14847
  description: Create a user for your organization.
14427
14848
  operationId: CreateUser
@@ -14461,21 +14882,6 @@ paths:
14461
14882
  tags:
14462
14883
  - Users
14463
14884
  x-codegen-request-body-name: body
14464
- x-given:
14465
- user:
14466
- parameters:
14467
- - name: body
14468
- value: "{\n \"data\": {\n \"attributes\": {\n \"email\": \"{{
14469
- unique }}@datadoghq.com\",\n \"title\": \"user title\"\n },\n
14470
- \ \"type\": \"users\"\n }\n}"
14471
- step: there is a valid "user" in the system
14472
- x-menu-order: 2
14473
- x-undo:
14474
- operationId: DisableUser
14475
- parameters:
14476
- - name: user_id
14477
- source: data.id
14478
- type: unsafe
14479
14885
  /api/v2/users/{user_id}:
14480
14886
  delete:
14481
14887
  description: 'Disable a user. Can only be used with an application key belonging
@@ -14510,9 +14916,6 @@ paths:
14510
14916
  tags:
14511
14917
  - Users
14512
14918
  x-codegen-request-body-name: body
14513
- x-menu-order: 5
14514
- x-undo:
14515
- type: idempotent
14516
14919
  get:
14517
14920
  description: "Get a user in the organization specified by the user\u2019s `user_id`."
14518
14921
  operationId: GetUser
@@ -14547,9 +14950,6 @@ paths:
14547
14950
  tags:
14548
14951
  - Users
14549
14952
  x-codegen-request-body-name: body
14550
- x-menu-order: 3
14551
- x-undo:
14552
- type: safe
14553
14953
  patch:
14554
14954
  description: 'Edit a user. Can only be used with an application key belonging
14555
14955
 
@@ -14605,9 +15005,6 @@ paths:
14605
15005
  tags:
14606
15006
  - Users
14607
15007
  x-codegen-request-body-name: body
14608
- x-menu-order: 4
14609
- x-undo:
14610
- type: idempotent
14611
15008
  /api/v2/users/{user_id}/orgs:
14612
15009
  get:
14613
15010
  description: 'Get a user organization. Returns the user information and all
@@ -14646,9 +15043,6 @@ paths:
14646
15043
  tags:
14647
15044
  - Users
14648
15045
  x-codegen-request-body-name: body
14649
- x-menu-order: 6
14650
- x-undo:
14651
- type: safe
14652
15046
  /api/v2/users/{user_id}/permissions:
14653
15047
  get:
14654
15048
  description: "Get a user permission set. Returns a list of the user\u2019s permissions\ngranted
@@ -14685,9 +15079,6 @@ paths:
14685
15079
  tags:
14686
15080
  - Users
14687
15081
  x-codegen-request-body-name: body
14688
- x-menu-order: 7
14689
- x-undo:
14690
- type: safe
14691
15082
  security:
14692
15083
  - apiKeyAuth: []
14693
15084
  appKeyAuth: []