datadog_api_client 2.1.0 → 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 (130) hide show
  1. checksums.yaml +4 -4
  2. data/.apigentools-info +4 -4
  3. data/.generator/poetry.lock +21 -14
  4. data/.generator/pyproject.toml +1 -1
  5. data/.generator/schemas/v1/openapi.yaml +558 -8
  6. data/.generator/schemas/v2/openapi.yaml +973 -253
  7. data/.generator/src/generator/templates/api_client.j2 +5 -1
  8. data/.generator/src/generator/templates/configuration.j2 +17 -0
  9. data/.github/workflows/test.yml +3 -0
  10. data/.pre-commit-config.yaml +1 -1
  11. data/CHANGELOG.md +26 -0
  12. data/README.md +11 -0
  13. data/examples/v1/dashboards/CreateDashboard_1423904722.rb +38 -0
  14. data/examples/v1/dashboards/CreateDashboard_2652180930.rb +43 -0
  15. data/examples/v1/dashboards/CreateDashboard_2850365602.rb +55 -0
  16. data/examples/v1/dashboards/CreateDashboard_3117424216.rb +33 -0
  17. data/examples/v1/dashboards/CreateDashboard_3669695268.rb +50 -0
  18. data/examples/v1/dashboards/CreateDashboard_858397694.rb +41 -0
  19. data/examples/v1/synthetics/CreateGlobalVariable_1068962881.rb +1 -1
  20. data/examples/v2/incidents/ListIncidentAttachments.rb +8 -0
  21. data/examples/v2/incidents/ListIncidentAttachments_2457735435.rb +11 -0
  22. data/examples/v2/incidents/UpdateIncidentAttachments.rb +38 -0
  23. data/examples/v2/incidents/UpdateIncidentAttachments_3881702075.rb +26 -0
  24. data/examples/v2/metrics/ListActiveMetricConfigurations.rb +5 -0
  25. data/examples/v2/metrics/ListTagConfigurations.rb +1 -1
  26. data/examples/v2/metrics/ListTagConfigurations_265033704.rb +8 -0
  27. data/examples/v2/metrics/{ListTagConfigurations_103226315.rb → ListTagConfigurations_2739018321.rb} +1 -1
  28. data/examples/v2/security-monitoring/CreateSecurityMonitoringRule.rb +3 -2
  29. data/examples/v2/security-monitoring/CreateSecurityMonitoringRule_461183901.rb +2 -2
  30. data/examples/v2/security-monitoring/CreateSecurityMonitoringRule_498211763.rb +2 -2
  31. data/examples/v2/security-monitoring/CreateSecurityMonitoringRule_914562040.rb +50 -0
  32. data/examples/v2/security-monitoring/GetSecurityMonitoringSignal.rb +5 -0
  33. data/examples/v2/security-monitoring/UpdateSecurityMonitoringRule.rb +2 -1
  34. data/examples/v2/usage-metering/GetEstimatedCostByOrg.rb +1 -4
  35. data/examples/v2/usage-metering/GetEstimatedCostByOrg_2734954020.rb +2 -4
  36. data/examples/v2/usage-metering/GetEstimatedCostByOrg_3186693804.rb +2 -4
  37. data/examples/v2/usage-metering/GetHistoricalCostByOrg.rb +8 -0
  38. data/generate.sh +30 -0
  39. data/lib/datadog_api_client/api_client.rb +5 -1
  40. data/lib/datadog_api_client/configuration.rb +20 -1
  41. data/lib/datadog_api_client/inflector.rb +51 -1
  42. data/lib/datadog_api_client/v1/api/service_level_objectives_api.rb +3 -1
  43. data/lib/datadog_api_client/v1/api/usage_metering_api.rb +5 -5
  44. data/lib/datadog_api_client/v1/models/dashboard_template_variable.rb +14 -2
  45. data/lib/datadog_api_client/v1/models/dashboard_template_variable_preset_value.rb +28 -5
  46. data/lib/datadog_api_client/v1/models/formula_and_function_event_query_definition.rb +14 -4
  47. data/lib/datadog_api_client/v1/models/hourly_usage_attribution_usage_type.rb +1 -0
  48. data/lib/datadog_api_client/v1/models/list_stream_query.rb +14 -4
  49. data/lib/datadog_api_client/v1/models/monthly_usage_attribution_supported_metrics.rb +2 -0
  50. data/lib/datadog_api_client/v1/models/monthly_usage_attribution_values.rb +21 -1
  51. data/lib/datadog_api_client/v1/models/search_service_level_objective.rb +111 -0
  52. data/lib/datadog_api_client/v1/models/search_service_level_objective_attributes.rb +286 -0
  53. data/lib/datadog_api_client/v1/models/search_service_level_objective_data.rb +134 -0
  54. data/lib/datadog_api_client/v1/models/search_slo_query.rb +137 -0
  55. data/lib/datadog_api_client/v1/models/search_slo_response_data_attributes.rb +8 -8
  56. data/lib/datadog_api_client/v1/models/search_slo_response_links.rb +2 -0
  57. data/lib/datadog_api_client/v1/models/search_slo_threshold.rb +184 -0
  58. data/lib/datadog_api_client/v1/models/search_slo_timeframe.rb +28 -0
  59. data/lib/datadog_api_client/v1/models/slo_creator.rb +131 -0
  60. data/lib/datadog_api_client/v1/models/slo_list_widget_definition.rb +185 -0
  61. data/lib/datadog_api_client/v1/models/slo_list_widget_definition_type.rb +26 -0
  62. data/lib/datadog_api_client/v1/models/slo_list_widget_query.rb +149 -0
  63. data/lib/datadog_api_client/v1/models/slo_list_widget_request.rb +143 -0
  64. data/lib/datadog_api_client/v1/models/slo_list_widget_request_type.rb +26 -0
  65. data/lib/datadog_api_client/v1/models/slo_overall_statuses.rb +174 -0
  66. data/lib/datadog_api_client/v1/models/slo_raw_error_budget_remaining.rb +121 -0
  67. data/lib/datadog_api_client/v1/models/synthetics_assertion_operator.rb +1 -0
  68. data/lib/datadog_api_client/v1/models/topology_map_widget_definition.rb +193 -0
  69. data/lib/datadog_api_client/v1/models/topology_map_widget_definition_type.rb +26 -0
  70. data/lib/datadog_api_client/v1/models/topology_query.rb +144 -0
  71. data/lib/datadog_api_client/v1/models/topology_query_data_source.rb +27 -0
  72. data/lib/datadog_api_client/v1/models/topology_request.rb +121 -0
  73. data/lib/datadog_api_client/v1/models/topology_request_type.rb +26 -0
  74. data/lib/datadog_api_client/v1/models/usage_attribution_sort.rb +2 -0
  75. data/lib/datadog_api_client/v1/models/usage_attribution_supported_metrics.rb +2 -0
  76. data/lib/datadog_api_client/v1/models/usage_attribution_values.rb +21 -1
  77. data/lib/datadog_api_client/v1/models/usage_fargate_hour.rb +11 -1
  78. data/lib/datadog_api_client/v1/models/usage_summary_date.rb +11 -1
  79. data/lib/datadog_api_client/v1/models/usage_summary_date_org.rb +11 -1
  80. data/lib/datadog_api_client/v1/models/usage_summary_response.rb +11 -1
  81. data/lib/datadog_api_client/v1/models/widget_definition.rb +3 -1
  82. data/lib/datadog_api_client/v2/api/incident_services_api.rb +2 -2
  83. data/lib/datadog_api_client/v2/api/incident_teams_api.rb +2 -2
  84. data/lib/datadog_api_client/v2/api/incidents_api.rb +155 -0
  85. data/lib/datadog_api_client/v2/api/metrics_api.rb +76 -8
  86. data/lib/datadog_api_client/v2/api/security_monitoring_api.rb +65 -0
  87. data/lib/datadog_api_client/v2/api/usage_metering_api.rb +83 -17
  88. data/lib/datadog_api_client/v2/models/incident_attachment_attachment_type.rb +27 -0
  89. data/lib/datadog_api_client/v2/models/incident_attachment_attributes.rb +63 -0
  90. data/lib/datadog_api_client/v2/models/incident_attachment_data.rb +187 -0
  91. data/lib/datadog_api_client/v2/models/incident_attachment_link_attachment_type.rb +26 -0
  92. data/lib/datadog_api_client/v2/models/incident_attachment_link_attributes.rb +145 -0
  93. data/lib/datadog_api_client/v2/models/incident_attachment_link_attributes_attachment_object.rb +143 -0
  94. data/lib/datadog_api_client/v2/models/incident_attachment_postmortem_attachment_type.rb +26 -0
  95. data/lib/datadog_api_client/v2/models/incident_attachment_postmortem_attributes.rb +145 -0
  96. data/lib/datadog_api_client/v2/models/incident_attachment_related_object.rb +26 -0
  97. data/lib/datadog_api_client/v2/models/incident_attachment_relationships.rb +111 -0
  98. data/lib/datadog_api_client/v2/models/incident_attachment_type.rb +26 -0
  99. data/lib/datadog_api_client/v2/models/incident_attachment_update_attributes.rb +63 -0
  100. data/lib/datadog_api_client/v2/models/incident_attachment_update_data.rb +144 -0
  101. data/lib/datadog_api_client/v2/models/incident_attachment_update_request.rb +127 -0
  102. data/lib/datadog_api_client/v2/models/incident_attachment_update_response.rb +137 -0
  103. data/lib/datadog_api_client/v2/models/incident_attachments_postmortem_attributes_attachment_object.rb +143 -0
  104. data/lib/datadog_api_client/v2/models/incident_attachments_response.rb +136 -0
  105. data/lib/datadog_api_client/v2/models/incident_attachments_response_included_item.rb +62 -0
  106. data/lib/datadog_api_client/v2/models/incident_related_object.rb +1 -0
  107. data/lib/datadog_api_client/v2/models/incident_response_attributes.rb +1 -11
  108. data/lib/datadog_api_client/v2/models/incident_response_included_item.rb +2 -1
  109. data/lib/datadog_api_client/v2/models/incident_response_relationships.rb +14 -14
  110. data/lib/datadog_api_client/v2/models/metric_active_configuration_type.rb +26 -0
  111. data/lib/datadog_api_client/v2/models/metric_suggested_tags_and_aggregations.rb +133 -0
  112. data/lib/datadog_api_client/v2/models/metric_suggested_tags_and_aggregations_response.rb +111 -0
  113. data/lib/datadog_api_client/v2/models/metric_suggested_tags_attributes.rb +125 -0
  114. data/lib/datadog_api_client/v2/models/relationship_to_incident_attachment.rb +124 -0
  115. data/lib/datadog_api_client/v2/models/relationship_to_incident_attachment_data.rb +145 -0
  116. data/lib/datadog_api_client/v2/models/security_monitoring_rule_create_payload.rb +36 -248
  117. data/lib/datadog_api_client/v2/models/security_monitoring_rule_query.rb +36 -151
  118. data/lib/datadog_api_client/v2/models/security_monitoring_rule_query_aggregation.rb +1 -0
  119. data/lib/datadog_api_client/v2/models/security_monitoring_rule_response.rb +37 -253
  120. data/lib/datadog_api_client/v2/models/security_monitoring_signal_rule_create_payload.rb +275 -0
  121. data/lib/datadog_api_client/v2/models/security_monitoring_signal_rule_query.rb +187 -0
  122. data/lib/datadog_api_client/v2/models/security_monitoring_signal_rule_response.rb +279 -0
  123. data/lib/datadog_api_client/v2/models/security_monitoring_signal_rule_type.rb +26 -0
  124. data/lib/datadog_api_client/v2/models/security_monitoring_standard_rule_create_payload.rb +275 -0
  125. data/lib/datadog_api_client/v2/models/{security_monitoring_rule_query_create.rb → security_monitoring_standard_rule_query.rb} +3 -3
  126. data/lib/datadog_api_client/v2/models/security_monitoring_standard_rule_response.rb +279 -0
  127. data/lib/datadog_api_client/version.rb +1 -1
  128. metadata +70 -6
  129. data/Makefile +0 -7
  130. 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
@@ -2114,6 +2134,243 @@ components:
2114
2134
  type: string
2115
2135
  x-mimetype: application/xml
2116
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
2117
2374
  IncidentCreateAttributes:
2118
2375
  description: The incident's attributes for a create request.
2119
2376
  properties:
@@ -2278,9 +2535,11 @@ components:
2278
2535
  description: Object related to an incident.
2279
2536
  enum:
2280
2537
  - users
2538
+ - attachments
2281
2539
  type: string
2282
2540
  x-enum-varnames:
2283
2541
  - USERS
2542
+ - ATTACHMENTS
2284
2543
  IncidentResponse:
2285
2544
  description: Response with an incident.
2286
2545
  properties:
@@ -2355,10 +2614,6 @@ components:
2355
2614
  $ref: '#/components/schemas/IncidentNotificationHandle'
2356
2615
  nullable: true
2357
2616
  type: array
2358
- postmortem_id:
2359
- description: The UUID of the postmortem object attached to the incident.
2360
- example: 00000000-0000-0000-7890-000000000000
2361
- type: string
2362
2617
  public_id:
2363
2618
  description: The monotonically increasing integer ID for the incident.
2364
2619
  example: 1
@@ -2423,6 +2678,7 @@ components:
2423
2678
  description: An object related to an incident that is included in the response.
2424
2679
  oneOf:
2425
2680
  - $ref: '#/components/schemas/User'
2681
+ - $ref: '#/components/schemas/IncidentAttachmentData'
2426
2682
  type: object
2427
2683
  IncidentResponseMeta:
2428
2684
  description: The metadata object containing pagination metadata.
@@ -2454,6 +2710,8 @@ components:
2454
2710
  IncidentResponseRelationships:
2455
2711
  description: The incident's relationships from a response.
2456
2712
  properties:
2713
+ attachments:
2714
+ $ref: '#/components/schemas/RelationshipToIncidentAttachment'
2457
2715
  commander_user:
2458
2716
  $ref: '#/components/schemas/NullableRelationshipToUser'
2459
2717
  created_by_user:
@@ -2462,8 +2720,6 @@ components:
2462
2720
  $ref: '#/components/schemas/RelationshipToIncidentIntegrationMetadatas'
2463
2721
  last_modified_by_user:
2464
2722
  $ref: '#/components/schemas/RelationshipToUser'
2465
- postmortem:
2466
- $ref: '#/components/schemas/RelationshipToIncidentPostmortem'
2467
2723
  type: object
2468
2724
  IncidentServiceCreateAttributes:
2469
2725
  description: The incident service's attributes for a create request.
@@ -2934,7 +3190,6 @@ components:
2934
3190
  customer_impacted: false
2935
3191
  detected: '2020-04-14T00:00:00+00:00'
2936
3192
  modified: '2020-09-17T14:16:58.696424+00:00'
2937
- postmortem_id: 00000000-0000-bbbb-0000-000000000000
2938
3193
  public_id: 1
2939
3194
  resolved: null
2940
3195
  severity: SEV-1
@@ -2945,6 +3200,12 @@ components:
2945
3200
  title: Example Incident
2946
3201
  id: 00000000-aaaa-0000-0000-000000000000
2947
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
2948
3209
  commander_user:
2949
3210
  data:
2950
3211
  id: 00000000-0000-0000-cccc-000000000000
@@ -2963,10 +3224,6 @@ components:
2963
3224
  data:
2964
3225
  id: 00000000-0000-0000-cccc-000000000000
2965
3226
  type: users
2966
- postmortem:
2967
- data:
2968
- id: 00000000-9999-0000-0000-000000000000
2969
- type: incident_postmortems
2970
3227
  type: incidents
2971
3228
  - attributes:
2972
3229
  created: '2020-04-21T15:34:08.627205+00:00'
@@ -2978,7 +3235,6 @@ components:
2978
3235
  customer_impacted: false
2979
3236
  detected: '2020-04-14T00:00:00+00:00'
2980
3237
  modified: '2020-09-17T14:16:58.696424+00:00'
2981
- postmortem_id: 00000000-6006-0000-0000-000000000000
2982
3238
  public_id: 2
2983
3239
  resolved: null
2984
3240
  severity: SEV-5
@@ -2989,6 +3245,10 @@ components:
2989
3245
  title: Example Incident 2
2990
3246
  id: 00000000-1111-0000-0000-000000000000
2991
3247
  relationships:
3248
+ attachments:
3249
+ data:
3250
+ - id: 00000000-9999-0000-0000-000000000000
3251
+ type: incident_attachments
2992
3252
  commander_user:
2993
3253
  data:
2994
3254
  id: 00000000-aaaa-0000-0000-000000000000
@@ -3007,10 +3267,6 @@ components:
3007
3267
  data:
3008
3268
  id: 00000000-aaaa-0000-0000-000000000000
3009
3269
  type: users
3010
- postmortem:
3011
- data:
3012
- id: 00000000-6006-0000-0000-000000000000
3013
- type: incident_postmortems
3014
3270
  type: incidents
3015
3271
  items:
3016
3272
  $ref: '#/components/schemas/IncidentResponseData'
@@ -4156,6 +4412,15 @@ components:
4156
4412
  type:
4157
4413
  $ref: '#/components/schemas/MetricType'
4158
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
4159
4424
  MetricAllTags:
4160
4425
  description: Object for a single metric's indexed tags.
4161
4426
  properties:
@@ -4681,6 +4946,50 @@ components:
4681
4946
  - metric
4682
4947
  - points
4683
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
4684
4993
  MetricTagConfiguration:
4685
4994
  description: Object for a single metric tag configuration.
4686
4995
  example:
@@ -6144,6 +6453,30 @@ components:
6144
6453
  from the other indexes
6145
6454
  type: string
6146
6455
  type: object
6456
+ RelationshipToIncidentAttachment:
6457
+ description: A relationship reference for attachments.
6458
+ properties:
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
6147
6480
  RelationshipToIncidentIntegrationMetadataData:
6148
6481
  description: A relationship reference for an integration metadata object.
6149
6482
  example:
@@ -6941,62 +7274,9 @@ components:
6941
7274
  type: object
6942
7275
  SecurityMonitoringRuleCreatePayload:
6943
7276
  description: Create a new rule.
6944
- properties:
6945
- cases:
6946
- description: Cases for generating signals.
6947
- example: []
6948
- items:
6949
- $ref: '#/components/schemas/SecurityMonitoringRuleCaseCreate'
6950
- type: array
6951
- filters:
6952
- description: Additional queries to filter matched events before they are
6953
- processed.
6954
- items:
6955
- $ref: '#/components/schemas/SecurityMonitoringFilter'
6956
- type: array
6957
- hasExtendedTitle:
6958
- description: Whether the notifications include the triggering group-by values
6959
- in their title.
6960
- example: true
6961
- type: boolean
6962
- isEnabled:
6963
- description: Whether the rule is enabled.
6964
- example: true
6965
- type: boolean
6966
- message:
6967
- description: Message for generated signals.
6968
- example: ''
6969
- type: string
6970
- name:
6971
- description: The name of the rule.
6972
- example: My security monitoring rule.
6973
- type: string
6974
- options:
6975
- $ref: '#/components/schemas/SecurityMonitoringRuleOptions'
6976
- queries:
6977
- description: Queries for selecting logs which are part of the rule.
6978
- example: []
6979
- items:
6980
- $ref: '#/components/schemas/SecurityMonitoringRuleQueryCreate'
6981
- type: array
6982
- tags:
6983
- description: Tags for generated signals.
6984
- example:
6985
- - env:prod
6986
- - team:security
6987
- items:
6988
- description: Tag.
6989
- type: string
6990
- type: array
6991
- type:
6992
- $ref: '#/components/schemas/SecurityMonitoringRuleTypeCreate'
6993
- required:
6994
- - name
6995
- - isEnabled
6996
- - queries
6997
- - options
6998
- - cases
6999
- - message
7277
+ oneOf:
7278
+ - $ref: '#/components/schemas/SecurityMonitoringStandardRuleCreatePayload'
7279
+ - $ref: '#/components/schemas/SecurityMonitoringSignalRuleCreatePayload'
7000
7280
  type: object
7001
7281
  SecurityMonitoringRuleDecreaseCriticalityBasedOnEnv:
7002
7282
  description: 'If true, signals in non-production environments have a lower severity
@@ -7221,39 +7501,9 @@ components:
7221
7501
  type: object
7222
7502
  SecurityMonitoringRuleQuery:
7223
7503
  description: Query for matching rule.
7224
- properties:
7225
- aggregation:
7226
- $ref: '#/components/schemas/SecurityMonitoringRuleQueryAggregation'
7227
- distinctFields:
7228
- description: Field for which the cardinality is measured. Sent as an array.
7229
- items:
7230
- description: Field.
7231
- type: string
7232
- type: array
7233
- groupByFields:
7234
- description: Fields to group by.
7235
- items:
7236
- description: Field.
7237
- type: string
7238
- type: array
7239
- metric:
7240
- description: 'The target field to aggregate over when using the sum or max
7241
-
7242
- aggregations.'
7243
- type: string
7244
- metrics:
7245
- description: Group of target fields to aggregate over when using the new
7246
- value aggregations.
7247
- items:
7248
- description: Field.
7249
- type: string
7250
- type: array
7251
- name:
7252
- description: Name of the query.
7253
- type: string
7254
- query:
7255
- description: Query to run on logs.
7256
- type: string
7504
+ oneOf:
7505
+ - $ref: '#/components/schemas/SecurityMonitoringStandardRuleQuery'
7506
+ - $ref: '#/components/schemas/SecurityMonitoringSignalRuleQuery'
7257
7507
  type: object
7258
7508
  SecurityMonitoringRuleQueryAggregation:
7259
7509
  description: The aggregation type.
@@ -7264,6 +7514,7 @@ components:
7264
7514
  - max
7265
7515
  - new_value
7266
7516
  - geo_data
7517
+ - event_count
7267
7518
  type: string
7268
7519
  x-enum-varnames:
7269
7520
  - COUNT
@@ -7272,112 +7523,13 @@ components:
7272
7523
  - MAX
7273
7524
  - NEW_VALUE
7274
7525
  - GEO_DATA
7275
- SecurityMonitoringRuleQueryCreate:
7276
- description: Query for matching rule.
7277
- properties:
7278
- aggregation:
7279
- $ref: '#/components/schemas/SecurityMonitoringRuleQueryAggregation'
7280
- distinctFields:
7281
- description: Field for which the cardinality is measured. Sent as an array.
7282
- items:
7283
- description: Field.
7284
- type: string
7285
- type: array
7286
- groupByFields:
7287
- description: Fields to group by.
7288
- items:
7289
- description: Field.
7290
- type: string
7291
- type: array
7292
- metric:
7293
- description: 'The target field to aggregate over when using the sum or max
7294
-
7295
- aggregations.'
7296
- type: string
7297
- metrics:
7298
- description: Group of target fields to aggregate over when using the new
7299
- value aggregations.
7300
- items:
7301
- description: Field.
7302
- type: string
7303
- type: array
7304
- name:
7305
- description: Name of the query.
7306
- type: string
7307
- query:
7308
- description: Query to run on logs.
7309
- example: a > 3
7310
- type: string
7311
- required:
7312
- - query
7313
- type: object
7526
+ - EVENT_COUNT
7314
7527
  SecurityMonitoringRuleResponse:
7315
- description: Rule.
7316
- properties:
7317
- cases:
7318
- description: Cases for generating signals.
7319
- items:
7320
- $ref: '#/components/schemas/SecurityMonitoringRuleCase'
7321
- type: array
7322
- createdAt:
7323
- description: When the rule was created, timestamp in milliseconds.
7324
- format: int64
7325
- type: integer
7326
- creationAuthorId:
7327
- description: User ID of the user who created the rule.
7328
- format: int64
7329
- type: integer
7330
- filters:
7331
- description: Additional queries to filter matched events before they are
7332
- processed.
7333
- items:
7334
- $ref: '#/components/schemas/SecurityMonitoringFilter'
7335
- type: array
7336
- hasExtendedTitle:
7337
- description: Whether the notifications include the triggering group-by values
7338
- in their title.
7339
- type: boolean
7340
- id:
7341
- description: The ID of the rule.
7342
- type: string
7343
- isDefault:
7344
- description: Whether the rule is included by default.
7345
- type: boolean
7346
- isDeleted:
7347
- description: Whether the rule has been deleted.
7348
- type: boolean
7349
- isEnabled:
7350
- description: Whether the rule is enabled.
7351
- type: boolean
7352
- message:
7353
- description: Message for generated signals.
7354
- type: string
7355
- name:
7356
- description: The name of the rule.
7357
- type: string
7358
- options:
7359
- $ref: '#/components/schemas/SecurityMonitoringRuleOptions'
7360
- queries:
7361
- description: Queries for selecting logs which are part of the rule.
7362
- items:
7363
- $ref: '#/components/schemas/SecurityMonitoringRuleQuery'
7364
- type: array
7365
- tags:
7366
- description: Tags for generated signals.
7367
- items:
7368
- description: Tag.
7369
- type: string
7370
- type: array
7371
- type:
7372
- $ref: '#/components/schemas/SecurityMonitoringRuleTypeRead'
7373
- updateAuthorId:
7374
- description: User ID of the user who updated the rule.
7375
- format: int64
7376
- type: integer
7377
- version:
7378
- description: The version of the rule.
7379
- format: int64
7380
- type: integer
7528
+ description: Create a new rule.
7529
+ oneOf:
7530
+ - $ref: '#/components/schemas/SecurityMonitoringStandardRuleResponse'
7531
+ - $ref: '#/components/schemas/SecurityMonitoringSignalRuleResponse'
7532
+ type: object
7381
7533
  SecurityMonitoringRuleSeverity:
7382
7534
  description: Severity of the Security Signal.
7383
7535
  enum:
@@ -7638,6 +7790,172 @@ components:
7638
7790
  maximum: 1000
7639
7791
  type: integer
7640
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
7641
7959
  SecurityMonitoringSignalState:
7642
7960
  description: The new triage state of the signal.
7643
7961
  enum:
@@ -7767,33 +8085,198 @@ components:
7767
8085
  POST endpoint.'
7768
8086
  example: https://app.datadoghq.com/api/v2/security_monitoring/signals?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==
7769
8087
  type: string
7770
- type: object
7771
- SecurityMonitoringSignalsListResponseMeta:
7772
- description: Meta attributes.
7773
- properties:
7774
- page:
7775
- $ref: '#/components/schemas/SecurityMonitoringSignalsListResponseMetaPage'
7776
- type: object
7777
- SecurityMonitoringSignalsListResponseMetaPage:
7778
- description: Paging attributes.
7779
- properties:
7780
- after:
7781
- description: 'The cursor used to get the next results, if any. To make the
7782
- next request, use the same
7783
-
7784
- parameters with the addition of the `page[cursor]`.'
7785
- example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==
8088
+ type: object
8089
+ SecurityMonitoringSignalsListResponseMeta:
8090
+ description: Meta attributes.
8091
+ properties:
8092
+ page:
8093
+ $ref: '#/components/schemas/SecurityMonitoringSignalsListResponseMetaPage'
8094
+ type: object
8095
+ SecurityMonitoringSignalsListResponseMetaPage:
8096
+ description: Paging attributes.
8097
+ properties:
8098
+ after:
8099
+ description: 'The cursor used to get the next results, if any. To make the
8100
+ next request, use the same
8101
+
8102
+ parameters with the addition of the `page[cursor]`.'
8103
+ example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==
8104
+ type: string
8105
+ type: object
8106
+ SecurityMonitoringSignalsSort:
8107
+ description: The sort parameters used for querying security signals.
8108
+ enum:
8109
+ - timestamp
8110
+ - -timestamp
8111
+ type: string
8112
+ x-enum-varnames:
8113
+ - TIMESTAMP_ASCENDING
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.
7786
8256
  type: string
7787
- type: object
7788
- SecurityMonitoringSignalsSort:
7789
- description: The sort parameters used for querying security signals.
7790
- enum:
7791
- - timestamp
7792
- - -timestamp
7793
- type: string
7794
- x-enum-varnames:
7795
- - TIMESTAMP_ASCENDING
7796
- - TIMESTAMP_DESCENDING
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
7797
8280
  SecurityMonitoringTriageUser:
7798
8281
  description: Object representing a given user entity.
7799
8282
  properties:
@@ -9583,6 +10066,80 @@ paths:
9583
10066
  x-unstable: '**Note**: This endpoint is in public beta.
9584
10067
 
9585
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'
10125
+ description: OK
10126
+ '400':
10127
+ $ref: '#/components/responses/BadRequestResponse'
10128
+ '401':
10129
+ $ref: '#/components/responses/UnauthorizedResponse'
10130
+ '403':
10131
+ $ref: '#/components/responses/ForbiddenResponse'
10132
+ '404':
10133
+ $ref: '#/components/responses/NotFoundResponse'
10134
+ '429':
10135
+ $ref: '#/components/responses/TooManyRequestsResponse'
10136
+ summary: Create, update, and delete incident attachments
10137
+ tags:
10138
+ - Incidents
10139
+ x-codegen-request-body-name: body
10140
+ x-unstable: '**Note**: This endpoint is in public beta.
10141
+
10142
+ If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
9586
10143
  /api/v2/integration/opsgenie/services:
9587
10144
  get:
9588
10145
  description: Get a list of all services from the Datadog Opsgenie integration.
@@ -10615,12 +11172,10 @@ paths:
10615
11172
  resultsPath: data
10616
11173
  /api/v2/metrics:
10617
11174
  get:
10618
- description: 'Returns all configured count/gauge/rate/distribution metric names
10619
-
10620
- (with additional filters if specified).'
11175
+ description: Returns all metrics (matching additional filters if specified).
10621
11176
  operationId: ListTagConfigurations
10622
11177
  parameters:
10623
- - description: Filter metrics that have configured tags.
11178
+ - description: Filter custom metrics that have configured tags.
10624
11179
  example: true
10625
11180
  in: query
10626
11181
  name: filter[configured]
@@ -10635,7 +11190,7 @@ paths:
10635
11190
  schema:
10636
11191
  description: Tag keys to filter by.
10637
11192
  type: string
10638
- - description: Filter tag configurations by metric type.
11193
+ - description: Filter metrics by metric type.
10639
11194
  in: query
10640
11195
  name: filter[metric_type]
10641
11196
  required: false
@@ -10650,10 +11205,21 @@ paths:
10650
11205
  required: false
10651
11206
  schema:
10652
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
10653
11219
  - description: 'Filter metrics that have been submitted with the given tags.
10654
11220
  Supports boolean and wildcard expressions.
10655
11221
 
10656
- Cannot be combined with other filters.'
11222
+ Can only be combined with the filter[queried] filter.'
10657
11223
  example: env IN (staging,test) AND service:web
10658
11224
  in: query
10659
11225
  name: filter[tags]
@@ -10661,9 +11227,9 @@ paths:
10661
11227
  schema:
10662
11228
  type: string
10663
11229
  - description: 'The number of seconds of look back (from now) to apply to a
10664
- filter[tag] query.
11230
+ filter[tag] or filter[queried] query.
10665
11231
 
10666
- 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).'
10667
11233
  example: 3600
10668
11234
  in: query
10669
11235
  name: window[seconds]
@@ -10701,7 +11267,7 @@ paths:
10701
11267
  appKeyAuth: []
10702
11268
  - AuthZ:
10703
11269
  - metrics_read
10704
- summary: List tag configurations
11270
+ summary: Get a list of metrics
10705
11271
  tags:
10706
11272
  - Metrics
10707
11273
  /api/v2/metrics/config/bulk-tags:
@@ -10817,6 +11383,63 @@ paths:
10817
11383
  tags:
10818
11384
  - Metrics
10819
11385
  x-codegen-request-body-name: body
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
10820
11443
  /api/v2/metrics/{metric_name}/all-tags:
10821
11444
  get:
10822
11445
  description: View indexed tag key-value pairs for a given metric name.
@@ -12744,6 +13367,31 @@ paths:
12744
13367
  cursorPath: meta.page.after
12745
13368
  limitParam: body.page.limit
12746
13369
  resultsPath: data
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
12747
13395
  /api/v2/security_monitoring/signals/{signal_id}/assignee:
12748
13396
  patch:
12749
13397
  description: Modify the triage assignee of a security signal.
@@ -13595,8 +14243,17 @@ paths:
13595
14243
  - Usage Metering
13596
14244
  /api/v2/usage/cost_by_org:
13597
14245
  get:
13598
- description: Get cost across multi-org account. Cost by org data for a given
13599
- 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.'
13600
14257
  operationId: GetCostByOrg
13601
14258
  parameters:
13602
14259
  - description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]`
@@ -13653,14 +14310,16 @@ paths:
13653
14310
  description: 'Get estimated cost across multi-org and single root-org accounts.
13654
14311
 
13655
14312
  Estimated cost data is only available for the current month and previous month.
13656
- 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.'
13657
14315
  operationId: GetEstimatedCostByOrg
13658
14316
  parameters:
13659
14317
  - description: String to specify whether cost is broken down at a parent-org
13660
- 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`.
13661
14320
  in: query
13662
14321
  name: view
13663
- required: true
14322
+ required: false
13664
14323
  schema:
13665
14324
  type: string
13666
14325
  - description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]`
@@ -13732,10 +14391,71 @@ paths:
13732
14391
  summary: Get estimated cost across your account
13733
14392
  tags:
13734
14393
  - Usage Metering
13735
- 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.
13736
14397
 
13737
- Only the sub-org view is available currently, the summary view will be released
13738
- 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
13739
14459
  /api/v2/usage/hourly_usage:
13740
14460
  get:
13741
14461
  description: Get hourly usage by product family