datadog_api_client 2.16.0 → 2.17.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 (182) hide show
  1. checksums.yaml +4 -4
  2. data/.apigentools-info +4 -4
  3. data/.generator/schemas/v1/openapi.yaml +654 -11
  4. data/.generator/schemas/v2/openapi.yaml +1268 -206
  5. data/.generator/src/generator/formatter.py +4 -0
  6. data/.generator/src/generator/openapi.py +2 -0
  7. data/.generator/src/generator/templates/api_client.j2 +3 -0
  8. data/.generator/src/generator/templates/inflector.j2 +1 -1
  9. data/.generator/src/generator/templates/model_base.j2 +4 -0
  10. data/CHANGELOG.md +29 -0
  11. data/Gemfile +1 -0
  12. data/LICENSE-3rdparty.csv +1 -0
  13. data/datadog_api_client.gemspec +2 -0
  14. data/examples/v1/aws-integration/CreateAWSAccount.rb +1 -1
  15. data/examples/v1/aws-integration/CreateAWSEventBridgeSource.rb +12 -0
  16. data/examples/v1/aws-integration/CreateAWSTagFilter.rb +1 -1
  17. data/examples/v1/aws-integration/CreateNewAWSExternalID.rb +1 -1
  18. data/examples/v1/aws-integration/DeleteAWSAccount.rb +1 -1
  19. data/examples/v1/aws-integration/DeleteAWSEventBridgeSource.rb +11 -0
  20. data/examples/v1/aws-integration/ListAWSEventBridgeSources.rb +5 -0
  21. data/examples/v1/azure-integration/CreateAzureIntegration.rb +1 -0
  22. data/examples/v1/azure-integration/DeleteAzureIntegration.rb +1 -0
  23. data/examples/v1/azure-integration/UpdateAzureHostFilters.rb +1 -0
  24. data/examples/v1/azure-integration/UpdateAzureIntegration.rb +1 -0
  25. data/examples/v1/dashboards/CreateDashboard_1213075383.rb +7 -0
  26. data/examples/v1/monitors/CreateMonitor_1539578087.rb +0 -1
  27. data/examples/v2/ci-visibility-pipelines/CreateCIAppPipelineEvent.rb +3 -0
  28. data/examples/v2/ci-visibility-pipelines/CreateCIAppPipelineEvent_129899466.rb +3 -0
  29. data/examples/v2/confluent-cloud/DeleteConfluentAccount.rb +4 -1
  30. data/examples/v2/confluent-cloud/DeleteConfluentResource.rb +5 -0
  31. data/examples/v2/containers/ListContainers.rb +8 -0
  32. data/examples/v2/containers/ListContainers_2175733917.rb +11 -0
  33. data/examples/v2/containers/ListContainers_931009654.rb +11 -0
  34. data/examples/v2/downtimes/ListMonitorDowntimes.rb +1 -1
  35. data/examples/v2/key-management/CreateCurrentUserApplicationKey.rb +2 -7
  36. data/examples/v2/key-management/DeleteApplicationKey.rb +4 -1
  37. data/examples/v2/key-management/DeleteCurrentUserApplicationKey.rb +4 -1
  38. data/examples/v2/powerpack/CreatePowerpack.rb +1 -0
  39. data/examples/v2/powerpack/UpdatePowerpack.rb +1 -0
  40. data/examples/v2/security-monitoring/MuteFindings.rb +29 -0
  41. data/examples/v2/service-definition/CreateOrUpdateServiceDefinitions.rb +1 -1
  42. data/examples/v2/service-scorecards/CreateScorecardOutcomesBatch.rb +27 -0
  43. data/examples/v2/service-scorecards/CreateScorecardRule.rb +19 -0
  44. data/examples/v2/service-scorecards/DeleteScorecardRule.rb +11 -0
  45. data/examples/v2/service-scorecards/ListScorecardOutcomes.rb +8 -0
  46. data/examples/v2/service-scorecards/ListScorecardOutcomes_2663454275.rb +13 -0
  47. data/examples/v2/service-scorecards/ListScorecardRules.rb +8 -0
  48. data/examples/v2/service-scorecards/ListScorecardRules_4057666343.rb +13 -0
  49. data/examples/v2/synthetics/SetOnDemandConcurrencyCap.rb +3 -1
  50. data/examples/v2/teams/ListTeams_3429963470.rb +12 -0
  51. data/examples/v2/usage-metering/GetUsageApplicationSecurityMonitoring.rb +4 -1
  52. data/examples/v2/usage-metering/GetUsageLambdaTracedInvocations.rb +4 -1
  53. data/examples/v2/usage-metering/GetUsageObservabilityPipelines.rb +4 -1
  54. data/examples/v2/users/GetUser.rb +5 -2
  55. data/lib/datadog_api_client/api_client.rb +3 -0
  56. data/lib/datadog_api_client/configuration.rb +8 -1
  57. data/lib/datadog_api_client/inflector.rb +76 -9
  58. data/lib/datadog_api_client/v1/api/aws_integration_api.rb +194 -0
  59. data/lib/datadog_api_client/v1/api/monitors_api.rb +5 -1
  60. data/lib/datadog_api_client/v1/api/usage_metering_api.rb +3 -3
  61. data/lib/datadog_api_client/v1/model_base.rb +4 -0
  62. data/lib/datadog_api_client/v1/models/aws_account.rb +2 -1
  63. data/lib/datadog_api_client/v1/models/aws_event_bridge_account_configuration.rb +105 -0
  64. data/lib/datadog_api_client/v1/models/aws_event_bridge_create_request.rb +112 -0
  65. data/lib/datadog_api_client/v1/models/aws_event_bridge_create_response.rb +110 -0
  66. data/lib/datadog_api_client/v1/models/aws_event_bridge_create_status.rb +26 -0
  67. data/lib/datadog_api_client/v1/models/aws_event_bridge_delete_request.rb +100 -0
  68. data/lib/datadog_api_client/v1/models/aws_event_bridge_delete_response.rb +80 -0
  69. data/lib/datadog_api_client/v1/models/aws_event_bridge_delete_status.rb +26 -0
  70. data/lib/datadog_api_client/v1/models/aws_event_bridge_list_response.rb +92 -0
  71. data/lib/datadog_api_client/v1/models/aws_event_bridge_source.rb +90 -0
  72. data/lib/datadog_api_client/v1/models/azure_account.rb +12 -1
  73. data/lib/datadog_api_client/v1/models/hourly_usage_attribution_usage_type.rb +21 -0
  74. data/lib/datadog_api_client/v1/models/monitor_options.rb +1 -1
  75. data/lib/datadog_api_client/v1/models/monthly_usage_attribution_supported_metrics.rb +42 -0
  76. data/lib/datadog_api_client/v1/models/monthly_usage_attribution_values.rb +421 -1
  77. data/lib/datadog_api_client/v1/models/toplist_widget_definition.rb +11 -1
  78. data/lib/datadog_api_client/v1/models/toplist_widget_display.rb +63 -0
  79. data/lib/datadog_api_client/v1/models/toplist_widget_flat.rb +98 -0
  80. data/lib/datadog_api_client/v1/models/toplist_widget_flat_type.rb +26 -0
  81. data/lib/datadog_api_client/v1/models/toplist_widget_legend.rb +28 -0
  82. data/lib/datadog_api_client/v1/models/toplist_widget_scaling.rb +27 -0
  83. data/lib/datadog_api_client/v1/models/toplist_widget_stacked.rb +119 -0
  84. data/lib/datadog_api_client/v1/models/toplist_widget_stacked_type.rb +26 -0
  85. data/lib/datadog_api_client/v1/models/toplist_widget_style.rb +90 -0
  86. data/lib/datadog_api_client/v1/models/usage_summary_date.rb +11 -1
  87. data/lib/datadog_api_client/v1/models/usage_summary_date_org.rb +11 -1
  88. data/lib/datadog_api_client/v1/models/usage_summary_response.rb +11 -1
  89. data/lib/datadog_api_client/v2/api/ci_visibility_pipelines_api.rb +6 -0
  90. data/lib/datadog_api_client/v2/api/containers_api.rb +129 -0
  91. data/lib/datadog_api_client/v2/api/key_management_api.rb +8 -0
  92. data/lib/datadog_api_client/v2/api/metrics_api.rb +6 -3
  93. data/lib/datadog_api_client/v2/api/roles_api.rb +2 -0
  94. data/lib/datadog_api_client/v2/api/security_monitoring_api.rb +66 -72
  95. data/lib/datadog_api_client/v2/api/service_scorecards_api.rb +457 -0
  96. data/lib/datadog_api_client/v2/api/teams_api.rb +2 -0
  97. data/lib/datadog_api_client/v2/model_base.rb +4 -0
  98. data/lib/datadog_api_client/v2/models/{mute_finding_request.rb → bulk_mute_findings_request.rb} +6 -6
  99. data/lib/datadog_api_client/v2/models/{mute_finding_request_attributes.rb → bulk_mute_findings_request_attributes.rb} +5 -5
  100. data/lib/datadog_api_client/v2/models/{mute_finding_request_data.rb → bulk_mute_findings_request_data.rb} +28 -7
  101. data/lib/datadog_api_client/v2/models/bulk_mute_findings_request_meta.rb +82 -0
  102. data/lib/datadog_api_client/v2/models/bulk_mute_findings_request_meta_findings.rb +80 -0
  103. data/lib/datadog_api_client/v2/models/{mute_finding_request_properties.rb → bulk_mute_findings_request_properties.rb} +6 -6
  104. data/lib/datadog_api_client/v2/models/{mute_finding_response.rb → bulk_mute_findings_response.rb} +5 -5
  105. data/lib/datadog_api_client/v2/models/bulk_mute_findings_response_data.rb +90 -0
  106. data/lib/datadog_api_client/v2/models/{mute_finding_response_data.rb → container.rb} +9 -9
  107. data/lib/datadog_api_client/v2/models/container_attributes.rb +183 -0
  108. data/lib/datadog_api_client/v2/models/container_group.rb +110 -0
  109. data/lib/datadog_api_client/v2/models/container_group_attributes.rb +90 -0
  110. data/lib/datadog_api_client/v2/models/container_group_relationships.rb +80 -0
  111. data/lib/datadog_api_client/v2/models/container_group_relationships_link.rb +92 -0
  112. data/lib/datadog_api_client/v2/models/container_group_relationships_links.rb +80 -0
  113. data/lib/datadog_api_client/v2/models/container_group_type.rb +26 -0
  114. data/lib/datadog_api_client/v2/models/container_item.rb +63 -0
  115. data/lib/datadog_api_client/v2/models/container_meta.rb +80 -0
  116. data/lib/datadog_api_client/v2/models/container_meta_page.rb +160 -0
  117. data/lib/datadog_api_client/v2/models/container_meta_page_type.rb +26 -0
  118. data/lib/datadog_api_client/v2/models/container_type.rb +26 -0
  119. data/lib/datadog_api_client/v2/models/containers_response.rb +102 -0
  120. data/lib/datadog_api_client/v2/models/containers_response_links.rb +130 -0
  121. data/lib/datadog_api_client/v2/models/create_rule_request.rb +80 -0
  122. data/lib/datadog_api_client/v2/models/create_rule_request_data.rb +90 -0
  123. data/lib/datadog_api_client/v2/models/create_rule_response.rb +80 -0
  124. data/lib/datadog_api_client/v2/models/create_rule_response_data.rb +110 -0
  125. data/lib/datadog_api_client/v2/models/list_rules_response.rb +92 -0
  126. data/lib/datadog_api_client/v2/models/list_rules_response_data_item.rb +110 -0
  127. data/lib/datadog_api_client/v2/models/list_rules_response_links.rb +80 -0
  128. data/lib/datadog_api_client/v2/models/metric_bulk_tag_config_create_attributes.rb +13 -1
  129. data/lib/datadog_api_client/v2/models/metric_bulk_tag_config_status_attributes.rb +12 -1
  130. data/lib/datadog_api_client/v2/models/metric_tag_configuration_attributes.rb +13 -1
  131. data/lib/datadog_api_client/v2/models/metric_tag_configuration_create_attributes.rb +13 -1
  132. data/lib/datadog_api_client/v2/models/metric_tag_configuration_update_attributes.rb +13 -1
  133. data/lib/datadog_api_client/v2/models/outcome_type.rb +26 -0
  134. data/lib/datadog_api_client/v2/models/outcomes_batch_attributes.rb +82 -0
  135. data/lib/datadog_api_client/v2/models/outcomes_batch_request.rb +80 -0
  136. data/lib/datadog_api_client/v2/models/outcomes_batch_request_data.rb +90 -0
  137. data/lib/datadog_api_client/v2/models/outcomes_batch_request_item.rb +150 -0
  138. data/lib/datadog_api_client/v2/models/outcomes_batch_response.rb +121 -0
  139. data/lib/datadog_api_client/v2/models/outcomes_batch_response_attributes.rb +120 -0
  140. data/lib/datadog_api_client/v2/models/outcomes_batch_response_meta.rb +90 -0
  141. data/lib/datadog_api_client/v2/models/outcomes_batch_type.rb +26 -0
  142. data/lib/datadog_api_client/v2/models/outcomes_response.rb +104 -0
  143. data/lib/datadog_api_client/v2/models/outcomes_response_data_item.rb +110 -0
  144. data/lib/datadog_api_client/v2/models/outcomes_response_included_item.rb +100 -0
  145. data/lib/datadog_api_client/v2/models/outcomes_response_included_rule_attributes.rb +90 -0
  146. data/lib/datadog_api_client/v2/models/outcomes_response_links.rb +80 -0
  147. data/lib/datadog_api_client/v2/models/powerpack_group_widget.rb +14 -4
  148. data/lib/datadog_api_client/v2/models/relationship_to_outcome.rb +80 -0
  149. data/lib/datadog_api_client/v2/models/relationship_to_outcome_data.rb +90 -0
  150. data/lib/datadog_api_client/v2/models/relationship_to_rule.rb +80 -0
  151. data/lib/datadog_api_client/v2/models/relationship_to_rule_data.rb +80 -0
  152. data/lib/datadog_api_client/v2/models/relationship_to_rule_data_object.rb +90 -0
  153. data/lib/datadog_api_client/v2/models/rule_attributes.rb +160 -0
  154. data/lib/datadog_api_client/v2/models/rule_outcome_relationships.rb +80 -0
  155. data/lib/datadog_api_client/v2/models/rule_type.rb +26 -0
  156. data/lib/datadog_api_client/v2/models/scorecard_type.rb +26 -0
  157. data/lib/datadog_api_client/v2/models/security_monitoring_signal_attributes.rb +7 -7
  158. data/lib/datadog_api_client/v2/models/security_monitoring_standard_rule_query.rb +11 -1
  159. data/lib/datadog_api_client/v2/models/service_definition_v2_dot2.rb +8 -8
  160. data/lib/datadog_api_client/v2/models/state.rb +28 -0
  161. data/lib/datadog_api_client/v2/models/teams_field.rb +40 -0
  162. data/lib/datadog_api_client/v2/models/user_team_permission_attributes.rb +1 -1
  163. data/lib/datadog_api_client/v2/models/widget_live_span.rb +40 -0
  164. data/lib/datadog_api_client/version.rb +1 -1
  165. metadata +113 -25
  166. data/examples/v2/confluent-cloud/DeleteConfluentAccount_2919241291.rb +0 -8
  167. data/examples/v2/downtimes/ListMonitorDowntimes_128979780.rb +0 -5
  168. data/examples/v2/key-management/CreateCurrentUserApplicationKey_1999509896.rb +0 -14
  169. data/examples/v2/key-management/DeleteApplicationKey_771691550.rb +0 -8
  170. data/examples/v2/key-management/DeleteCurrentUserApplicationKey_1266687064.rb +0 -8
  171. data/examples/v2/key-management/GetCurrentUserApplicationKey_1060640890.rb +0 -8
  172. data/examples/v2/key-management/ListApplicationKeys_2237010090.rb +0 -5
  173. data/examples/v2/key-management/ListCurrentUserApplicationKeys_1503860964.rb +0 -5
  174. data/examples/v2/security-monitoring/UpdateFinding.rb +0 -23
  175. data/examples/v2/synthetics/GetOnDemandConcurrencyCap_2633566918.rb +0 -5
  176. data/examples/v2/synthetics/SetOnDemandConcurrencyCap_2850884405.rb +0 -9
  177. data/examples/v2/usage-metering/GetUsageApplicationSecurityMonitoring_3959166796.rb +0 -8
  178. data/examples/v2/usage-metering/GetUsageLambdaTracedInvocations_1436752065.rb +0 -8
  179. data/examples/v2/usage-metering/GetUsageObservabilityPipelines_970725512.rb +0 -8
  180. data/examples/v2/users/GetUser_3047557953.rb +0 -8
  181. data/lib/datadog_api_client/v2/models/mute_finding_response_attributes.rb +0 -191
  182. data/lib/datadog_api_client/v2/models/mute_finding_response_properties.rb +0 -114
@@ -4,6 +4,13 @@ components:
4
4
  headers: {}
5
5
  links: {}
6
6
  parameters:
7
+ APIKeyCategoryParameter:
8
+ description: Filter API keys by category.
9
+ in: query
10
+ name: filter[category]
11
+ required: false
12
+ schema:
13
+ type: string
7
14
  APIKeyFilterCreatedAtEndParameter:
8
15
  description: Only include API keys created on or before the specified date.
9
16
  in: query
@@ -59,6 +66,13 @@ components:
59
66
  schema:
60
67
  example: created_by,modified_by
61
68
  type: string
69
+ APIKeyReadConfigReadEnabledParameter:
70
+ description: Filter API keys by remote config read enabled status.
71
+ in: query
72
+ name: filter[remote_config_read_enabled]
73
+ required: false
74
+ schema:
75
+ type: boolean
62
76
  APIKeysSortParameter:
63
77
  description: 'API key attribute used to sort results. Sort order is ascending
64
78
 
@@ -383,6 +397,13 @@ components:
383
397
  required: true
384
398
  schema:
385
399
  type: string
400
+ RuleId:
401
+ description: The ID of the rule/scorecard.
402
+ in: path
403
+ name: rule_id
404
+ required: true
405
+ schema:
406
+ type: string
386
407
  SchemaVersion:
387
408
  description: The schema version desired in the response.
388
409
  in: query
@@ -1269,6 +1290,104 @@ components:
1269
1290
  type: string
1270
1291
  x-enum-varnames:
1271
1292
  - AUTHN_MAPPINGS
1293
+ BulkMuteFindingsRequest:
1294
+ description: The new bulk mute finding request.
1295
+ properties:
1296
+ data:
1297
+ $ref: '#/components/schemas/BulkMuteFindingsRequestData'
1298
+ required:
1299
+ - data
1300
+ type: object
1301
+ BulkMuteFindingsRequestAttributes:
1302
+ additionalProperties: false
1303
+ description: The mute properties to be updated.
1304
+ properties:
1305
+ mute:
1306
+ $ref: '#/components/schemas/BulkMuteFindingsRequestProperties'
1307
+ required:
1308
+ - mute
1309
+ type: object
1310
+ BulkMuteFindingsRequestData:
1311
+ description: Data object containing the new bulk mute properties of the finding.
1312
+ properties:
1313
+ attributes:
1314
+ $ref: '#/components/schemas/BulkMuteFindingsRequestAttributes'
1315
+ id:
1316
+ description: UUID to identify the request
1317
+ example: dbe5f567-192b-4404-b908-29b70e1c9f76
1318
+ type: string
1319
+ meta:
1320
+ $ref: '#/components/schemas/BulkMuteFindingsRequestMeta'
1321
+ type:
1322
+ $ref: '#/components/schemas/FindingType'
1323
+ required:
1324
+ - id
1325
+ - type
1326
+ - attributes
1327
+ - meta
1328
+ type: object
1329
+ BulkMuteFindingsRequestMeta:
1330
+ description: Meta object containing the findings to be updated.
1331
+ properties:
1332
+ findings:
1333
+ description: Array of findings.
1334
+ items:
1335
+ $ref: '#/components/schemas/BulkMuteFindingsRequestMetaFindings'
1336
+ type: array
1337
+ type: object
1338
+ BulkMuteFindingsRequestMetaFindings:
1339
+ description: Finding object containing the finding information.
1340
+ properties:
1341
+ finding_id:
1342
+ $ref: '#/components/schemas/FindingID'
1343
+ type: object
1344
+ BulkMuteFindingsRequestProperties:
1345
+ additionalProperties: false
1346
+ description: Object containing the new mute properties of the findings.
1347
+ properties:
1348
+ description:
1349
+ description: Additional information about the reason why those findings
1350
+ are muted or unmuted. This field has a maximum limit of 280 characters.
1351
+ type: string
1352
+ expiration_date:
1353
+ description: 'The expiration date of the mute or unmute action (Unix ms).
1354
+ It must be set to a value greater than the current timestamp.
1355
+
1356
+ If this field is not provided, the finding will be muted or unmuted indefinitely,
1357
+ which is equivalent to setting the expiration date to 9999999999999.
1358
+
1359
+ '
1360
+ example: 1778721573794
1361
+ format: int64
1362
+ type: integer
1363
+ muted:
1364
+ description: Whether those findings should be muted or unmuted.
1365
+ example: true
1366
+ type: boolean
1367
+ reason:
1368
+ $ref: '#/components/schemas/FindingMuteReason'
1369
+ required:
1370
+ - muted
1371
+ - reason
1372
+ type: object
1373
+ BulkMuteFindingsResponse:
1374
+ description: The expected response schema.
1375
+ properties:
1376
+ data:
1377
+ $ref: '#/components/schemas/BulkMuteFindingsResponseData'
1378
+ required:
1379
+ - data
1380
+ type: object
1381
+ BulkMuteFindingsResponseData:
1382
+ description: Data object containing the ID of the request that was updated.
1383
+ properties:
1384
+ id:
1385
+ description: UUID used to identify the request
1386
+ example: 93bfeb70-af47-424d-908a-948d3f08e37f
1387
+ type: string
1388
+ type:
1389
+ $ref: '#/components/schemas/FindingType'
1390
+ type: object
1272
1391
  CIAppAggregateBucketValue:
1273
1392
  description: A bucket value, can either be a timeseries or a single value.
1274
1393
  oneOf:
@@ -3441,6 +3560,117 @@ components:
3441
3560
  $ref: '#/components/schemas/ConfluentResourceResponseData'
3442
3561
  type: array
3443
3562
  type: object
3563
+ Container:
3564
+ description: Container object.
3565
+ properties:
3566
+ attributes:
3567
+ $ref: '#/components/schemas/ContainerAttributes'
3568
+ id:
3569
+ description: Container ID.
3570
+ type: string
3571
+ type:
3572
+ $ref: '#/components/schemas/ContainerType'
3573
+ type: object
3574
+ ContainerAttributes:
3575
+ description: Attributes for a container.
3576
+ properties:
3577
+ container_id:
3578
+ description: The ID of the container.
3579
+ type: string
3580
+ created_at:
3581
+ description: Time the container was created.
3582
+ type: string
3583
+ host:
3584
+ description: Hostname of the host running the container.
3585
+ type: string
3586
+ image_digest:
3587
+ description: Digest of the compressed image manifest.
3588
+ nullable: true
3589
+ type: string
3590
+ image_name:
3591
+ description: Name of the associated container image.
3592
+ type: string
3593
+ image_tags:
3594
+ description: List of image tags associated with the container image.
3595
+ items:
3596
+ type: string
3597
+ nullable: true
3598
+ type: array
3599
+ name:
3600
+ description: Name of the container.
3601
+ type: string
3602
+ started_at:
3603
+ description: Time the container was started.
3604
+ type: string
3605
+ state:
3606
+ description: State of the container. This depends on the container runtime.
3607
+ type: string
3608
+ tags:
3609
+ description: List of tags associated with the container.
3610
+ items:
3611
+ type: string
3612
+ type: array
3613
+ type: object
3614
+ ContainerGroup:
3615
+ description: Container group object.
3616
+ properties:
3617
+ attributes:
3618
+ $ref: '#/components/schemas/ContainerGroupAttributes'
3619
+ id:
3620
+ description: Container Group ID.
3621
+ type: string
3622
+ relationships:
3623
+ $ref: '#/components/schemas/ContainerGroupRelationships'
3624
+ type:
3625
+ $ref: '#/components/schemas/ContainerGroupType'
3626
+ type: object
3627
+ ContainerGroupAttributes:
3628
+ description: Attributes for a container group.
3629
+ properties:
3630
+ count:
3631
+ description: Number of containers in the group.
3632
+ format: int64
3633
+ type: integer
3634
+ tags:
3635
+ description: Tags from the group name parsed in key/value format.
3636
+ type: object
3637
+ type: object
3638
+ ContainerGroupRelationships:
3639
+ description: Relationships to containers inside a container group.
3640
+ properties:
3641
+ containers:
3642
+ $ref: '#/components/schemas/ContainerGroupRelationshipsLink'
3643
+ type: object
3644
+ ContainerGroupRelationshipsData:
3645
+ description: Links data.
3646
+ items:
3647
+ description: A link data.
3648
+ type: string
3649
+ type: array
3650
+ ContainerGroupRelationshipsLink:
3651
+ description: Relationships to Containers inside a Container Group.
3652
+ properties:
3653
+ data:
3654
+ $ref: '#/components/schemas/ContainerGroupRelationshipsData'
3655
+ links:
3656
+ $ref: '#/components/schemas/ContainerGroupRelationshipsLinks'
3657
+ type: object
3658
+ ContainerGroupRelationshipsLinks:
3659
+ description: Links attributes.
3660
+ properties:
3661
+ related:
3662
+ description: Link to related containers.
3663
+ type: string
3664
+ type: object
3665
+ ContainerGroupType:
3666
+ default: container_group
3667
+ description: Type of container group.
3668
+ enum:
3669
+ - container_group
3670
+ example: container_group
3671
+ type: string
3672
+ x-enum-varnames:
3673
+ - CONTAINER_GROUP
3444
3674
  ContainerImage:
3445
3675
  description: Container Image object.
3446
3676
  properties:
@@ -3751,6 +3981,96 @@ components:
3751
3981
  description: Link to current page.
3752
3982
  type: string
3753
3983
  type: object
3984
+ ContainerItem:
3985
+ description: Possible Container models.
3986
+ oneOf:
3987
+ - $ref: '#/components/schemas/Container'
3988
+ - $ref: '#/components/schemas/ContainerGroup'
3989
+ ContainerMeta:
3990
+ description: Response metadata object.
3991
+ properties:
3992
+ pagination:
3993
+ $ref: '#/components/schemas/ContainerMetaPage'
3994
+ type: object
3995
+ ContainerMetaPage:
3996
+ description: Paging attributes.
3997
+ properties:
3998
+ cursor:
3999
+ description: The cursor used to get the current results, if any.
4000
+ type: string
4001
+ limit:
4002
+ description: Number of results returned
4003
+ format: int32
4004
+ maximum: 10000
4005
+ minimum: 0
4006
+ type: integer
4007
+ next_cursor:
4008
+ description: The cursor used to get the next results, if any.
4009
+ type: string
4010
+ prev_cursor:
4011
+ description: The cursor used to get the previous results, if any.
4012
+ nullable: true
4013
+ type: string
4014
+ total:
4015
+ description: Total number of records that match the query.
4016
+ format: int64
4017
+ type: integer
4018
+ type:
4019
+ $ref: '#/components/schemas/ContainerMetaPageType'
4020
+ type: object
4021
+ ContainerMetaPageType:
4022
+ default: cursor_limit
4023
+ description: Type of Container pagination.
4024
+ enum:
4025
+ - cursor_limit
4026
+ example: cursor_limit
4027
+ type: string
4028
+ x-enum-varnames:
4029
+ - CURSOR_LIMIT
4030
+ ContainerType:
4031
+ default: container
4032
+ description: Type of container.
4033
+ enum:
4034
+ - container
4035
+ example: container
4036
+ type: string
4037
+ x-enum-varnames:
4038
+ - CONTAINER
4039
+ ContainersResponse:
4040
+ description: List of containers.
4041
+ properties:
4042
+ data:
4043
+ description: Array of Container objects.
4044
+ items:
4045
+ $ref: '#/components/schemas/ContainerItem'
4046
+ type: array
4047
+ links:
4048
+ $ref: '#/components/schemas/ContainersResponseLinks'
4049
+ meta:
4050
+ $ref: '#/components/schemas/ContainerMeta'
4051
+ type: object
4052
+ ContainersResponseLinks:
4053
+ description: Pagination links.
4054
+ properties:
4055
+ first:
4056
+ description: Link to the first page.
4057
+ type: string
4058
+ last:
4059
+ description: Link to the last page.
4060
+ nullable: true
4061
+ type: string
4062
+ next:
4063
+ description: Link to the next page.
4064
+ nullable: true
4065
+ type: string
4066
+ prev:
4067
+ description: Link to previous page.
4068
+ nullable: true
4069
+ type: string
4070
+ self:
4071
+ description: Link to current page.
4072
+ type: string
4073
+ type: object
3754
4074
  ContentEncoding:
3755
4075
  description: HTTP header used to compress the media-type.
3756
4076
  enum:
@@ -3818,6 +4138,38 @@ components:
3818
4138
  type: string
3819
4139
  x-enum-varnames:
3820
4140
  - COST_BY_ORG
4141
+ CreateRuleRequest:
4142
+ description: Scorecard create rule request.
4143
+ properties:
4144
+ data:
4145
+ $ref: '#/components/schemas/CreateRuleRequestData'
4146
+ type: object
4147
+ CreateRuleRequestData:
4148
+ description: Scorecard create rule request data.
4149
+ properties:
4150
+ attributes:
4151
+ $ref: '#/components/schemas/RuleAttributes'
4152
+ type:
4153
+ $ref: '#/components/schemas/RuleType'
4154
+ type: object
4155
+ CreateRuleResponse:
4156
+ description: Created rule in response.
4157
+ properties:
4158
+ data:
4159
+ $ref: '#/components/schemas/CreateRuleResponseData'
4160
+ type: object
4161
+ CreateRuleResponseData:
4162
+ description: Create rule response data.
4163
+ properties:
4164
+ attributes:
4165
+ $ref: '#/components/schemas/RuleAttributes'
4166
+ id:
4167
+ $ref: '#/components/schemas/RuleId'
4168
+ relationships:
4169
+ $ref: '#/components/schemas/RelationshipToRule'
4170
+ type:
4171
+ $ref: '#/components/schemas/RuleType'
4172
+ type: object
3821
4173
  Creator:
3822
4174
  description: Creator of the object.
3823
4175
  properties:
@@ -5431,7 +5783,7 @@ components:
5431
5783
  type: integer
5432
5784
  FindingID:
5433
5785
  description: The unique ID for this finding.
5434
- example: AQAAAYbb1i0gijTHEQAAAABBWWJiMWkwZ0FBQ2FuNzBJVGZXZ3B3QUE
5786
+ example: ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw==
5435
5787
  type: string
5436
5788
  FindingMute:
5437
5789
  additionalProperties: false
@@ -7987,6 +8339,39 @@ components:
7987
8339
  meta:
7988
8340
  $ref: '#/components/schemas/PowerpacksResponseMeta'
7989
8341
  type: object
8342
+ ListRulesResponse:
8343
+ description: Scorecard rules response.
8344
+ properties:
8345
+ data:
8346
+ $ref: '#/components/schemas/ListRulesResponseData'
8347
+ links:
8348
+ $ref: '#/components/schemas/ListRulesResponseLinks'
8349
+ type: object
8350
+ ListRulesResponseData:
8351
+ description: Array of rule details.
8352
+ items:
8353
+ $ref: '#/components/schemas/ListRulesResponseDataItem'
8354
+ type: array
8355
+ ListRulesResponseDataItem:
8356
+ description: Rule details.
8357
+ properties:
8358
+ attributes:
8359
+ $ref: '#/components/schemas/RuleAttributes'
8360
+ id:
8361
+ $ref: '#/components/schemas/RuleId'
8362
+ relationships:
8363
+ $ref: '#/components/schemas/RelationshipToRule'
8364
+ type:
8365
+ $ref: '#/components/schemas/RuleType'
8366
+ type: object
8367
+ ListRulesResponseLinks:
8368
+ description: Links attributes.
8369
+ properties:
8370
+ next:
8371
+ description: Link for the next set of rules.
8372
+ example: /api/v2/scorecard/rules?page%5Blimit%5D=2&page%5Boffset%5D=2&page%5Bsize%5D=2
8373
+ type: string
8374
+ type: object
7990
8375
  ListTeamsInclude:
7991
8376
  description: Included related resources optionally requested.
7992
8377
  enum:
@@ -9217,6 +9602,15 @@ components:
9217
9602
  properties:
9218
9603
  emails:
9219
9604
  $ref: '#/components/schemas/MetricBulkTagConfigEmailList'
9605
+ exclude_tags_mode:
9606
+ description: 'When set to true, the configuration will exclude the configured
9607
+ tags and include any other submitted tags.
9608
+
9609
+ When set to false, the configuration will include the configured tags
9610
+ and exclude any other submitted tags.
9611
+
9612
+ Defaults to false.'
9613
+ type: boolean
9220
9614
  tags:
9221
9615
  $ref: '#/components/schemas/MetricBulkTagConfigTagNameList'
9222
9616
  type: object
@@ -9297,6 +9691,13 @@ components:
9297
9691
  properties:
9298
9692
  emails:
9299
9693
  $ref: '#/components/schemas/MetricBulkTagConfigEmailList'
9694
+ exclude_tags_mode:
9695
+ description: 'When set to true, the configuration will exclude the configured
9696
+ tags and include any other submitted tags.
9697
+
9698
+ When set to false, the configuration will include the configured tags
9699
+ and exclude any other submitted tags.'
9700
+ type: boolean
9300
9701
  status:
9301
9702
  description: The status of the request.
9302
9703
  example: Accepted
@@ -9761,6 +10162,15 @@ components:
9761
10162
  example: '2020-03-25T09:48:37.463835Z'
9762
10163
  format: date-time
9763
10164
  type: string
10165
+ exclude_tags_mode:
10166
+ description: 'When set to true, the configuration will exclude the configured
10167
+ tags and include any other submitted tags.
10168
+
10169
+ When set to false, the configuration will include the configured tags
10170
+ and exclude any other submitted tags.
10171
+
10172
+ Defaults to false. Requires `tags` property.'
10173
+ type: boolean
9764
10174
  include_percentiles:
9765
10175
  description: 'Toggle to include or exclude percentile aggregations for distribution
9766
10176
  metrics.
@@ -9791,6 +10201,15 @@ components:
9791
10201
  properties:
9792
10202
  aggregations:
9793
10203
  $ref: '#/components/schemas/MetricCustomAggregations'
10204
+ exclude_tags_mode:
10205
+ description: 'When set to true, the configuration will exclude the configured
10206
+ tags and include any other submitted tags.
10207
+
10208
+ When set to false, the configuration will include the configured tags
10209
+ and exclude any other submitted tags.
10210
+
10211
+ Defaults to false. Requires `tags` property.'
10212
+ type: boolean
9794
10213
  include_percentiles:
9795
10214
  description: 'Toggle to include/exclude percentiles for a distribution metric.
9796
10215
 
@@ -9882,6 +10301,15 @@ components:
9882
10301
  properties:
9883
10302
  aggregations:
9884
10303
  $ref: '#/components/schemas/MetricCustomAggregations'
10304
+ exclude_tags_mode:
10305
+ description: 'When set to true, the configuration will exclude the configured
10306
+ tags and include any other submitted tags.
10307
+
10308
+ When set to false, the configuration will include the configured tags
10309
+ and exclude any other submitted tags.
10310
+
10311
+ Defaults to false. Requires `tags` property.'
10312
+ type: boolean
9885
10313
  include_percentiles:
9886
10314
  description: 'Toggle to include/exclude percentiles for a distribution metric.
9887
10315
 
@@ -10325,139 +10753,6 @@ components:
10325
10753
  description: The monitor type.
10326
10754
  type: string
10327
10755
  type: object
10328
- MuteFindingRequest:
10329
- description: The new mute finding request.
10330
- properties:
10331
- data:
10332
- $ref: '#/components/schemas/MuteFindingRequestData'
10333
- required:
10334
- - data
10335
- type: object
10336
- MuteFindingRequestAttributes:
10337
- additionalProperties: false
10338
- description: The mute properties to be updated.
10339
- properties:
10340
- mute:
10341
- $ref: '#/components/schemas/MuteFindingRequestProperties'
10342
- required:
10343
- - mute
10344
- type: object
10345
- MuteFindingRequestData:
10346
- description: Data object containing the new mute properties of the finding.
10347
- properties:
10348
- attributes:
10349
- $ref: '#/components/schemas/MuteFindingRequestAttributes'
10350
- id:
10351
- $ref: '#/components/schemas/FindingID'
10352
- type:
10353
- $ref: '#/components/schemas/FindingType'
10354
- required:
10355
- - id
10356
- - type
10357
- - attributes
10358
- type: object
10359
- MuteFindingRequestProperties:
10360
- additionalProperties: false
10361
- description: Object containing the new mute properties of the finding.
10362
- properties:
10363
- description:
10364
- description: Additional information about the reason why this finding is
10365
- muted or unmuted. This field has a maximum limit of 280 characters.
10366
- example: To be resolved later
10367
- type: string
10368
- expiration_date:
10369
- description: 'The expiration date of the mute or unmute action (Unix ms).
10370
- It must be set to a value greater than the current timestamp.
10371
-
10372
- If this field is not provided, the finding will be muted or unmuted indefinitely,
10373
- which is equivalent to setting the expiration date to 9999999999999.
10374
-
10375
- '
10376
- example: 1778721573794
10377
- format: int64
10378
- type: integer
10379
- muted:
10380
- description: Whether this finding is muted or unmuted.
10381
- example: true
10382
- type: boolean
10383
- reason:
10384
- $ref: '#/components/schemas/FindingMuteReason'
10385
- required:
10386
- - muted
10387
- - reason
10388
- type: object
10389
- MuteFindingResponse:
10390
- description: The expected response schema.
10391
- properties:
10392
- data:
10393
- $ref: '#/components/schemas/MuteFindingResponseData'
10394
- required:
10395
- - data
10396
- type: object
10397
- MuteFindingResponseAttributes:
10398
- description: The JSON:API attributes of the finding.
10399
- properties:
10400
- evaluation:
10401
- $ref: '#/components/schemas/FindingEvaluation'
10402
- evaluation_changed_at:
10403
- $ref: '#/components/schemas/FindingEvaluationChangedAt'
10404
- mute:
10405
- $ref: '#/components/schemas/MuteFindingResponseProperties'
10406
- resource:
10407
- $ref: '#/components/schemas/FindingResource'
10408
- resource_discovery_date:
10409
- $ref: '#/components/schemas/FindingResourceDiscoveryDate'
10410
- resource_type:
10411
- $ref: '#/components/schemas/FindingResourceType'
10412
- rule:
10413
- $ref: '#/components/schemas/FindingRule'
10414
- status:
10415
- $ref: '#/components/schemas/FindingStatus'
10416
- tags:
10417
- $ref: '#/components/schemas/FindingTags'
10418
- type: object
10419
- MuteFindingResponseData:
10420
- description: Data object containing the updated finding.
10421
- properties:
10422
- attributes:
10423
- $ref: '#/components/schemas/MuteFindingResponseAttributes'
10424
- id:
10425
- $ref: '#/components/schemas/FindingID'
10426
- type:
10427
- $ref: '#/components/schemas/FindingType'
10428
- type: object
10429
- MuteFindingResponseProperties:
10430
- additionalProperties: false
10431
- description: Information about the mute status of this finding.
10432
- properties:
10433
- description:
10434
- description: 'Additional information about the reason why this finding is
10435
- muted or unmuted.
10436
-
10437
- This attribute will not be included in the response if the description
10438
- is not provided in the request body.
10439
-
10440
- '
10441
- example: To be resolved later
10442
- type: string
10443
- expiration_date:
10444
- description: 'The expiration date of the mute or unmute action.
10445
-
10446
- If the expiration date is not provided in the request body, this attribute
10447
- will not be included in the response and the finding will be muted or
10448
- unmuted indefinitely.
10449
-
10450
- '
10451
- example: 1778721573794
10452
- format: int64
10453
- type: integer
10454
- muted:
10455
- description: Whether this finding is muted or unmuted.
10456
- example: true
10457
- type: boolean
10458
- reason:
10459
- $ref: '#/components/schemas/FindingMuteReason'
10460
- type: object
10461
10756
  NullableRelationshipToUser:
10462
10757
  description: Relationship to user.
10463
10758
  properties:
@@ -10729,6 +11024,185 @@ components:
10729
11024
  type: string
10730
11025
  x-enum-varnames:
10731
11026
  - ORGS
11027
+ OutcomeType:
11028
+ default: outcome
11029
+ description: The JSON:API type for an outcome.
11030
+ enum:
11031
+ - outcome
11032
+ example: outcome
11033
+ type: string
11034
+ x-enum-varnames:
11035
+ - OUTCOME
11036
+ OutcomesBatchAttributes:
11037
+ description: The JSON:API attributes for a batched set of scorecard outcomes.
11038
+ properties:
11039
+ results:
11040
+ description: Set of scorecard outcomes to update.
11041
+ items:
11042
+ $ref: '#/components/schemas/OutcomesBatchRequestItem'
11043
+ type: array
11044
+ type: object
11045
+ OutcomesBatchRequest:
11046
+ description: Scorecard outcomes batch request.
11047
+ properties:
11048
+ data:
11049
+ $ref: '#/components/schemas/OutcomesBatchRequestData'
11050
+ type: object
11051
+ OutcomesBatchRequestData:
11052
+ description: Scorecard outcomes batch request data.
11053
+ properties:
11054
+ attributes:
11055
+ $ref: '#/components/schemas/OutcomesBatchAttributes'
11056
+ type:
11057
+ $ref: '#/components/schemas/OutcomesBatchType'
11058
+ type: object
11059
+ OutcomesBatchRequestItem:
11060
+ description: Scorecard outcome for a specific rule, for a given service within
11061
+ a batched update.
11062
+ properties:
11063
+ remarks:
11064
+ description: Any remarks regarding the scorecard rule's evaluation, and
11065
+ supports HTML hyperlinks.
11066
+ example: 'See: <a href="https://app.datadoghq.com/services">Services</a>'
11067
+ type: string
11068
+ rule_id:
11069
+ $ref: '#/components/schemas/RuleId'
11070
+ service_name:
11071
+ description: The unique name for a service in the catalog.
11072
+ example: my-service
11073
+ type: string
11074
+ state:
11075
+ $ref: '#/components/schemas/State'
11076
+ required:
11077
+ - rule_id
11078
+ - service_name
11079
+ - state
11080
+ type: object
11081
+ OutcomesBatchResponse:
11082
+ description: Scorecard outcomes batch response.
11083
+ properties:
11084
+ data:
11085
+ $ref: '#/components/schemas/OutcomesBatchResponseData'
11086
+ meta:
11087
+ $ref: '#/components/schemas/OutcomesBatchResponseMeta'
11088
+ required:
11089
+ - data
11090
+ - meta
11091
+ type: object
11092
+ OutcomesBatchResponseAttributes:
11093
+ description: The JSON:API attributes for an outcome.
11094
+ properties:
11095
+ created_at:
11096
+ description: Creation time of the rule outcome.
11097
+ format: date-time
11098
+ type: string
11099
+ modified_at:
11100
+ description: Time of last rule outcome modification.
11101
+ format: date-time
11102
+ type: string
11103
+ remarks:
11104
+ description: Any remarks regarding the scorecard rule's evaluation, and
11105
+ supports HTML hyperlinks.
11106
+ example: 'See: <a href="https://app.datadoghq.com/services">Services</a>'
11107
+ type: string
11108
+ service_name:
11109
+ description: The unique name for a service in the catalog.
11110
+ example: my-service
11111
+ type: string
11112
+ state:
11113
+ $ref: '#/components/schemas/State'
11114
+ type: object
11115
+ OutcomesBatchResponseData:
11116
+ description: List of rule outcomes which were affected during the bulk operation.
11117
+ items:
11118
+ $ref: '#/components/schemas/OutcomesResponseDataItem'
11119
+ type: array
11120
+ OutcomesBatchResponseMeta:
11121
+ description: Metadata pertaining to the bulk operation.
11122
+ properties:
11123
+ total_received:
11124
+ description: Total number of scorecard results received during the bulk
11125
+ operation.
11126
+ format: int64
11127
+ type: integer
11128
+ total_updated:
11129
+ description: Total number of scorecard results modified during the bulk
11130
+ operation.
11131
+ format: int64
11132
+ type: integer
11133
+ type: object
11134
+ OutcomesBatchType:
11135
+ default: batched-outcome
11136
+ description: The JSON:API type for scorecard outcomes.
11137
+ enum:
11138
+ - batched-outcome
11139
+ example: batched-outcome
11140
+ type: string
11141
+ x-enum-varnames:
11142
+ - BATCHED_OUTCOME
11143
+ OutcomesResponse:
11144
+ description: Scorecard outcomes - the result of a rule for a service.
11145
+ properties:
11146
+ data:
11147
+ $ref: '#/components/schemas/OutcomesResponseData'
11148
+ included:
11149
+ $ref: '#/components/schemas/OutcomesResponseIncluded'
11150
+ links:
11151
+ $ref: '#/components/schemas/OutcomesResponseLinks'
11152
+ type: object
11153
+ OutcomesResponseData:
11154
+ description: List of rule outcomes.
11155
+ items:
11156
+ $ref: '#/components/schemas/OutcomesResponseDataItem'
11157
+ type: array
11158
+ OutcomesResponseDataItem:
11159
+ description: A single rule outcome.
11160
+ properties:
11161
+ attributes:
11162
+ $ref: '#/components/schemas/OutcomesBatchResponseAttributes'
11163
+ id:
11164
+ description: The unique ID for a rule outcome.
11165
+ type: string
11166
+ relationships:
11167
+ $ref: '#/components/schemas/RuleOutcomeRelationships'
11168
+ type:
11169
+ $ref: '#/components/schemas/OutcomeType'
11170
+ type: object
11171
+ OutcomesResponseIncluded:
11172
+ description: Array of rule details.
11173
+ items:
11174
+ $ref: '#/components/schemas/OutcomesResponseIncludedItem'
11175
+ type: array
11176
+ OutcomesResponseIncludedItem:
11177
+ description: Attributes of the included rule.
11178
+ properties:
11179
+ attributes:
11180
+ $ref: '#/components/schemas/OutcomesResponseIncludedRuleAttributes'
11181
+ id:
11182
+ $ref: '#/components/schemas/RuleId'
11183
+ type:
11184
+ $ref: '#/components/schemas/RuleType'
11185
+ type: object
11186
+ OutcomesResponseIncludedRuleAttributes:
11187
+ description: Details of a rule.
11188
+ properties:
11189
+ name:
11190
+ description: Name of the rule.
11191
+ example: Team Defined
11192
+ type: string
11193
+ scorecard_name:
11194
+ description: The scorecard name to which this rule must belong.
11195
+ example: Observability Best Practices
11196
+ type: string
11197
+ type: object
11198
+ OutcomesResponseLinks:
11199
+ description: Links attributes.
11200
+ properties:
11201
+ next:
11202
+ description: Link for the next set of results.
11203
+ example: /api/v2/scorecard/outcomes?include=rule&page%5Blimit%5D=100&page%5Boffset%5D=100
11204
+ type: string
11205
+ type: object
10732
11206
  Pagination:
10733
11207
  description: Pagination object.
10734
11208
  properties:
@@ -10955,6 +11429,8 @@ components:
10955
11429
  $ref: '#/components/schemas/PowerpackGroupWidgetDefinition'
10956
11430
  layout:
10957
11431
  $ref: '#/components/schemas/PowerpackGroupWidgetLayout'
11432
+ live_span:
11433
+ $ref: '#/components/schemas/WidgetLiveSpan'
10958
11434
  required:
10959
11435
  - definition
10960
11436
  type: object
@@ -12182,6 +12658,21 @@ components:
12182
12658
  required:
12183
12659
  - data
12184
12660
  type: object
12661
+ RelationshipToOutcome:
12662
+ description: The JSON:API relationship to a scorecard outcome.
12663
+ properties:
12664
+ data:
12665
+ $ref: '#/components/schemas/RelationshipToOutcomeData'
12666
+ type: object
12667
+ RelationshipToOutcomeData:
12668
+ description: The JSON:API relationship to an outcome, which returns the related
12669
+ rule id.
12670
+ properties:
12671
+ id:
12672
+ $ref: '#/components/schemas/RuleId'
12673
+ type:
12674
+ $ref: '#/components/schemas/RuleType'
12675
+ type: object
12185
12676
  RelationshipToPermission:
12186
12677
  description: Relationship to a permissions object.
12187
12678
  properties:
@@ -12231,6 +12722,28 @@ components:
12231
12722
  $ref: '#/components/schemas/RelationshipToRoleData'
12232
12723
  type: array
12233
12724
  type: object
12725
+ RelationshipToRule:
12726
+ description: Scorecard create rule response relationship.
12727
+ properties:
12728
+ scorecard:
12729
+ $ref: '#/components/schemas/RelationshipToRuleData'
12730
+ type: object
12731
+ RelationshipToRuleData:
12732
+ description: Relationship data for a rule.
12733
+ properties:
12734
+ data:
12735
+ $ref: '#/components/schemas/RelationshipToRuleDataObject'
12736
+ type: object
12737
+ RelationshipToRuleDataObject:
12738
+ description: Rule relationship data.
12739
+ properties:
12740
+ id:
12741
+ description: The unique ID for a scorecard.
12742
+ example: 00000000-0000-beef-0000-000000000000
12743
+ type: string
12744
+ type:
12745
+ $ref: '#/components/schemas/ScorecardType'
12746
+ type: object
12234
12747
  RelationshipToSAMLAssertionAttribute:
12235
12748
  description: AuthN Mapping relationship to SAML Assertion Attribute.
12236
12749
  properties:
@@ -12957,6 +13470,62 @@ components:
12957
13470
  type: string
12958
13471
  x-enum-varnames:
12959
13472
  - ROLES
13473
+ RuleAttributes:
13474
+ description: Details of a rule.
13475
+ properties:
13476
+ category:
13477
+ deprecated: true
13478
+ description: The scorecard name to which this rule must belong.
13479
+ type: string
13480
+ created_at:
13481
+ description: Creation time of the rule outcome.
13482
+ format: date-time
13483
+ type: string
13484
+ custom:
13485
+ description: Defines if the rule is a custom rule.
13486
+ type: boolean
13487
+ description:
13488
+ description: Explanation of the rule.
13489
+ type: string
13490
+ enabled:
13491
+ description: If enabled, the rule is calculated as part of the score.
13492
+ example: true
13493
+ type: boolean
13494
+ modified_at:
13495
+ description: Time of the last rule outcome modification.
13496
+ format: date-time
13497
+ type: string
13498
+ name:
13499
+ description: Name of the rule.
13500
+ example: Team Defined
13501
+ type: string
13502
+ owner:
13503
+ description: Owner of the rule.
13504
+ type: string
13505
+ scorecard_name:
13506
+ description: The scorecard name to which this rule must belong.
13507
+ example: Deployments automated via Deployment Trains
13508
+ type: string
13509
+ type: object
13510
+ RuleId:
13511
+ description: The unique ID for a scorecard rule.
13512
+ example: 00000000-0000-beef-0000-000000000000
13513
+ type: string
13514
+ RuleOutcomeRelationships:
13515
+ description: The JSON:API relationship to a scorecard rule.
13516
+ properties:
13517
+ rule:
13518
+ $ref: '#/components/schemas/RelationshipToOutcome'
13519
+ type: object
13520
+ RuleType:
13521
+ default: rule
13522
+ description: The JSON:API type for scorecard rules.
13523
+ enum:
13524
+ - rule
13525
+ example: rule
13526
+ type: string
13527
+ x-enum-varnames:
13528
+ - RULE
12960
13529
  SAMLAssertionAttribute:
12961
13530
  description: SAML assertion attribute.
12962
13531
  properties:
@@ -13142,6 +13711,15 @@ components:
13142
13711
  type:
13143
13712
  $ref: '#/components/schemas/ScalarFormulaResponseType'
13144
13713
  type: object
13714
+ ScorecardType:
13715
+ default: scorecard
13716
+ description: The JSON:API type for scorecard.
13717
+ enum:
13718
+ - scorecard
13719
+ example: scorecard
13720
+ type: string
13721
+ x-enum-varnames:
13722
+ - SCORECARD
13145
13723
  SecurityFilter:
13146
13724
  description: The security filter's properties.
13147
13725
  properties:
@@ -13855,7 +14433,7 @@ components:
13855
14433
 
13856
14434
  associated values.'
13857
14435
  properties:
13858
- attributes:
14436
+ custom:
13859
14437
  additionalProperties: {}
13860
14438
  description: A JSON object of attributes in the security signal.
13861
14439
  example:
@@ -14441,6 +15019,13 @@ components:
14441
15019
  description: Field.
14442
15020
  type: string
14443
15021
  type: array
15022
+ hasOptionalGroupByFields:
15023
+ description: When false, events without a group-by value are ignored by
15024
+ the rule. When true, events with missing group-by fields are processed
15025
+ with `N/A`, replacing the missing values.
15026
+ example: false
15027
+ readOnly: true
15028
+ type: boolean
14444
15029
  metric:
14445
15030
  deprecated: true
14446
15031
  description: '(Deprecated) The target field to aggregate over when using
@@ -15809,7 +16394,7 @@ components:
15809
16394
  type: object
15810
16395
  integrations:
15811
16396
  $ref: '#/components/schemas/ServiceDefinitionV2Dot2Integrations'
15812
- langauges:
16397
+ languages:
15813
16398
  description: 'The service''s programming language. Datadog recognizes the
15814
16399
  following languages: `dotnet`, `go`, `java`, `js`, `php`, `python`, `ruby`,
15815
16400
  and `c++`.'
@@ -17068,8 +17653,20 @@ components:
17068
17653
  from the other indexes
17069
17654
  type: string
17070
17655
  type: object
17071
- TagsEventAttribute:
17072
- description: Array of tags associated with your event.
17656
+ State:
17657
+ description: The state of the rule evaluation.
17658
+ enum:
17659
+ - pass
17660
+ - fail
17661
+ - skip
17662
+ example: pass
17663
+ type: string
17664
+ x-enum-varnames:
17665
+ - PASS
17666
+ - FAIL
17667
+ - SKIP
17668
+ TagsEventAttribute:
17669
+ description: Array of tags associated with your event.
17073
17670
  example:
17074
17671
  - team:A
17075
17672
  items:
@@ -17543,6 +18140,41 @@ components:
17543
18140
  required:
17544
18141
  - data
17545
18142
  type: object
18143
+ TeamsField:
18144
+ description: Supported teams field.
18145
+ enum:
18146
+ - id
18147
+ - name
18148
+ - handle
18149
+ - summary
18150
+ - description
18151
+ - avatar
18152
+ - banner
18153
+ - visible_modules
18154
+ - hidden_modules
18155
+ - created_at
18156
+ - modified_at
18157
+ - user_count
18158
+ - link_count
18159
+ - team_links
18160
+ - user_team_permissions
18161
+ type: string
18162
+ x-enum-varnames:
18163
+ - ID
18164
+ - NAME
18165
+ - HANDLE
18166
+ - SUMMARY
18167
+ - DESCRIPTION
18168
+ - AVATAR
18169
+ - BANNER
18170
+ - VISIBLE_MODULES
18171
+ - HIDDEN_MODULES
18172
+ - CREATED_AT
18173
+ - MODIFIED_AT
18174
+ - USER_COUNT
18175
+ - LINK_COUNT
18176
+ - TEAM_LINKS
18177
+ - USER_TEAM_PERMISSIONS
17546
18178
  TeamsResponse:
17547
18179
  description: Response with multiple teams
17548
18180
  properties:
@@ -18177,8 +18809,8 @@ components:
18177
18809
  description: User team permission attributes
18178
18810
  properties:
18179
18811
  permissions:
18180
- description: Object of team permission actions and boolean values indicating
18181
- of the currently logged in user can perform them on this team
18812
+ description: Object of team permission actions and boolean values that a
18813
+ logged in user can perform on this team.
18182
18814
  readOnly: true
18183
18815
  type: object
18184
18816
  type: object
@@ -18331,6 +18963,42 @@ components:
18331
18963
  type: string
18332
18964
  x-enum-varnames:
18333
18965
  - USERS
18966
+ WidgetLiveSpan:
18967
+ description: The available timeframes depend on the widget you are using.
18968
+ enum:
18969
+ - 1m
18970
+ - 5m
18971
+ - 10m
18972
+ - 15m
18973
+ - 30m
18974
+ - 1h
18975
+ - 4h
18976
+ - 1d
18977
+ - 2d
18978
+ - 1w
18979
+ - 1mo
18980
+ - 3mo
18981
+ - 6mo
18982
+ - 1y
18983
+ - alert
18984
+ example: 5m
18985
+ type: string
18986
+ x-enum-varnames:
18987
+ - PAST_ONE_MINUTE
18988
+ - PAST_FIVE_MINUTES
18989
+ - PAST_TEN_MINUTES
18990
+ - PAST_FIFTEEN_MINUTES
18991
+ - PAST_THIRTY_MINUTES
18992
+ - PAST_ONE_HOUR
18993
+ - PAST_FOUR_HOURS
18994
+ - PAST_ONE_DAY
18995
+ - PAST_TWO_DAYS
18996
+ - PAST_ONE_WEEK
18997
+ - PAST_ONE_MONTH
18998
+ - PAST_THREE_MONTHS
18999
+ - PAST_SIX_MONTHS
19000
+ - PAST_ONE_YEAR
19001
+ - ALERT
18334
19002
  securitySchemes:
18335
19003
  AuthZ:
18336
19004
  description: This API uses OAuth 2 with the implicit grant flow.
@@ -18433,6 +19101,8 @@ paths:
18433
19101
  - $ref: '#/components/parameters/APIKeyFilterModifiedAtStartParameter'
18434
19102
  - $ref: '#/components/parameters/APIKeyFilterModifiedAtEndParameter'
18435
19103
  - $ref: '#/components/parameters/APIKeyIncludeParameter'
19104
+ - $ref: '#/components/parameters/APIKeyReadConfigReadEnabledParameter'
19105
+ - $ref: '#/components/parameters/APIKeyCategoryParameter'
18436
19106
  responses:
18437
19107
  '200':
18438
19108
  content:
@@ -18866,6 +19536,7 @@ paths:
18866
19536
  - $ref: '#/components/parameters/ApplicationKeyFilterParameter'
18867
19537
  - $ref: '#/components/parameters/ApplicationKeyFilterCreatedAtStartParameter'
18868
19538
  - $ref: '#/components/parameters/ApplicationKeyFilterCreatedAtEndParameter'
19539
+ - $ref: '#/components/parameters/ApplicationKeyIncludeParameter'
18869
19540
  responses:
18870
19541
  '200':
18871
19542
  content:
@@ -19414,6 +20085,9 @@ paths:
19414
20085
  tags:
19415
20086
  - CI Visibility Pipelines
19416
20087
  x-codegen-request-body-name: body
20088
+ x-unstable: '**Note:** This endpoint is in public beta.
20089
+
20090
+ If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
19417
20091
  /api/v2/ci/pipelines/analytics/aggregate:
19418
20092
  post:
19419
20093
  description: Use this API endpoint to aggregate CI Visibility pipeline events
@@ -19814,6 +20488,86 @@ paths:
19814
20488
  x-unstable: '**Note**: This endpoint is in public beta.
19815
20489
 
19816
20490
  If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
20491
+ /api/v2/containers:
20492
+ get:
20493
+ description: Get all containers for your organization.
20494
+ operationId: ListContainers
20495
+ parameters:
20496
+ - description: Comma-separated list of tags to filter containers by.
20497
+ example: env:prod,short_image:cassandra
20498
+ in: query
20499
+ name: filter[tags]
20500
+ required: false
20501
+ schema:
20502
+ type: string
20503
+ - description: Comma-separated list of tags to group containers by.
20504
+ example: datacenter,cluster
20505
+ in: query
20506
+ name: group_by
20507
+ required: false
20508
+ schema:
20509
+ type: string
20510
+ - description: Attribute to sort containers by.
20511
+ example: started_at
20512
+ in: query
20513
+ name: sort
20514
+ required: false
20515
+ schema:
20516
+ type: string
20517
+ - description: Maximum number of results returned.
20518
+ in: query
20519
+ name: page[size]
20520
+ required: false
20521
+ schema:
20522
+ default: 1000
20523
+ format: int32
20524
+ maximum: 10000
20525
+ minimum: 1
20526
+ type: integer
20527
+ - description: 'String to query the next page of results.
20528
+
20529
+ This key is provided with each valid response from the API in `meta.pagination.next_cursor`.'
20530
+ in: query
20531
+ name: page[cursor]
20532
+ required: false
20533
+ schema:
20534
+ type: string
20535
+ responses:
20536
+ '200':
20537
+ content:
20538
+ application/json:
20539
+ schema:
20540
+ $ref: '#/components/schemas/ContainersResponse'
20541
+ description: OK
20542
+ '400':
20543
+ content:
20544
+ application/json:
20545
+ schema:
20546
+ $ref: '#/components/schemas/APIErrorResponse'
20547
+ description: Bad Request
20548
+ '403':
20549
+ content:
20550
+ application/json:
20551
+ schema:
20552
+ $ref: '#/components/schemas/APIErrorResponse'
20553
+ description: Authentication Error
20554
+ '429':
20555
+ $ref: '#/components/responses/TooManyRequestsResponse'
20556
+ security:
20557
+ - apiKeyAuth: []
20558
+ appKeyAuth: []
20559
+ - AuthZ: []
20560
+ summary: Get All Containers
20561
+ tags:
20562
+ - Containers
20563
+ x-pagination:
20564
+ cursorParam: page[cursor]
20565
+ cursorPath: meta.pagination.next_cursor
20566
+ limitParam: page[size]
20567
+ resultsPath: data
20568
+ x-unstable: '**Note**: This endpoint is in public beta.
20569
+
20570
+ If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
19817
20571
  /api/v2/current_user/application_keys:
19818
20572
  get:
19819
20573
  description: List all application keys available for current user
@@ -19825,6 +20579,7 @@ paths:
19825
20579
  - $ref: '#/components/parameters/ApplicationKeyFilterParameter'
19826
20580
  - $ref: '#/components/parameters/ApplicationKeyFilterCreatedAtStartParameter'
19827
20581
  - $ref: '#/components/parameters/ApplicationKeyFilterCreatedAtEndParameter'
20582
+ - $ref: '#/components/parameters/ApplicationKeyIncludeParameter'
19828
20583
  responses:
19829
20584
  '200':
19830
20585
  content:
@@ -20361,7 +21116,7 @@ paths:
20361
21116
  - apiKeyAuth: []
20362
21117
  appKeyAuth: []
20363
21118
  - AuthZ:
20364
- - monitors_read
21119
+ - monitors_downtime
20365
21120
  summary: Get a downtime
20366
21121
  tags:
20367
21122
  - Downtimes
@@ -23281,7 +24036,11 @@ paths:
23281
24036
  If multiple calls include the same metric, the last configuration applied
23282
24037
  (not by submit order) is used, do not
23283
24038
 
23284
- expect deterministic ordering of concurrent calls.
24039
+ expect deterministic ordering of concurrent calls. The `exclude_tags_mode`
24040
+ value will set all metrics that match the prefix to
24041
+
24042
+ the same exclusion state, metric tag configurations do not support mixed inclusion
24043
+ and exclusion for tags on the same metric.
23285
24044
 
23286
24045
  Can only be used with application keys of users with the `Manage Tags for
23287
24046
  Metrics` permission.'
@@ -23607,7 +24366,11 @@ paths:
23607
24366
  description: 'Update the tag configuration of a metric or percentile aggregations
23608
24367
  of a distribution metric or custom aggregations
23609
24368
 
23610
- of a count, rate, or gauge metric.
24369
+ of a count, rate, or gauge metric. By setting `exclude_tags_mode` to true
24370
+ the behavior is changed
24371
+
24372
+ from an allow-list to a deny-list, and tags in the defined list will not be
24373
+ queryable.
23611
24374
 
23612
24375
  Can only be used with application keys from users with the `Manage Tags for
23613
24376
  Metrics` permission.'
@@ -23662,7 +24425,11 @@ paths:
23662
24425
  Optionally, include percentile aggregations on any distribution metric or
23663
24426
  configure custom aggregations
23664
24427
 
23665
- on any count, rate, or gauge metric.
24428
+ on any count, rate, or gauge metric. By setting `exclude_tags_mode` to true
24429
+ the behavior is changed
24430
+
24431
+ from an allow-list to a deny-list, and tags in the defined list will not be
24432
+ queryable.
23666
24433
 
23667
24434
  Can only be used with application keys of users with the `Manage Tags for
23668
24435
  Metrics` permission.'
@@ -24162,32 +24929,28 @@ paths:
24162
24929
  x-unstable: '**Note**: This endpoint is in public beta.
24163
24930
 
24164
24931
  If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
24165
- /api/v2/posture_management/findings/{finding_id}:
24166
- get:
24167
- description: Returns a single finding with message and resource configuration.
24168
- operationId: GetFinding
24169
- parameters:
24170
- - description: The ID of the finding.
24171
- in: path
24172
- name: finding_id
24932
+ patch:
24933
+ description: Mute or unmute findings.
24934
+ operationId: MuteFindings
24935
+ requestBody:
24936
+ content:
24937
+ application/json:
24938
+ schema:
24939
+ $ref: '#/components/schemas/BulkMuteFindingsRequest'
24940
+ description: "### Attributes\n\nAll findings are updated with the same attributes.
24941
+ The request body must include at least two attributes: `muted` and `reason`.\nThe
24942
+ allowed reasons depend on whether the finding is being muted or unmuted:\n
24943
+ \ - To mute a finding: `PENDING_FIX`, `FALSE_POSITIVE`, `ACCEPTED_RISK`,
24944
+ `OTHER`.\n - To unmute a finding : `NO_PENDING_FIX`, `HUMAN_ERROR`, `NO_LONGER_ACCEPTED_RISK`,
24945
+ `OTHER`.\n\n### Meta\n\nThe request body must include a list of the finding
24946
+ IDs to be updated.\n"
24173
24947
  required: true
24174
- schema:
24175
- type: string
24176
- - description: Return the finding for a given snapshot of time (Unix ms).
24177
- example: 1678721573794
24178
- in: query
24179
- name: snapshot_timestamp
24180
- required: false
24181
- schema:
24182
- format: int64
24183
- minimum: 1
24184
- type: integer
24185
24948
  responses:
24186
24949
  '200':
24187
24950
  content:
24188
24951
  application/json:
24189
24952
  schema:
24190
- $ref: '#/components/schemas/GetFindingResponse'
24953
+ $ref: '#/components/schemas/BulkMuteFindingsResponse'
24191
24954
  description: OK
24192
24955
  '400':
24193
24956
  $ref: '#/components/responses/FindingsBadRequestResponse'
@@ -24195,24 +24958,29 @@ paths:
24195
24958
  $ref: '#/components/responses/FindingsForbiddenResponse'
24196
24959
  '404':
24197
24960
  $ref: '#/components/responses/FindingsNotFoundResponse'
24961
+ '422':
24962
+ content:
24963
+ application/json:
24964
+ schema:
24965
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
24966
+ description: 'Invalid Request: The server understands the request syntax
24967
+ but cannot process it due to invalid data.'
24198
24968
  '429':
24199
24969
  $ref: '#/components/responses/FindingsTooManyRequestsResponse'
24200
24970
  security:
24201
24971
  - apiKeyAuth: []
24202
24972
  appKeyAuth: []
24203
- - AuthZ:
24204
- - security_monitoring_findings_read
24205
- summary: Get a finding
24973
+ summary: Mute or unmute a batch of findings
24206
24974
  tags:
24207
24975
  - Security Monitoring
24976
+ x-codegen-request-body-name: body
24208
24977
  x-unstable: '**Note**: This endpoint is in public beta.
24209
24978
 
24210
24979
  If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
24211
- patch:
24212
- description: 'Mute or unmute a specific finding.
24213
-
24214
- The API returns the updated finding object when the request is successful.'
24215
- operationId: UpdateFinding
24980
+ /api/v2/posture_management/findings/{finding_id}:
24981
+ get:
24982
+ description: Returns a single finding with message and resource configuration.
24983
+ operationId: GetFinding
24216
24984
  parameters:
24217
24985
  - description: The ID of the finding.
24218
24986
  in: path
@@ -24220,28 +24988,21 @@ paths:
24220
24988
  required: true
24221
24989
  schema:
24222
24990
  type: string
24223
- requestBody:
24224
- content:
24225
- application/json:
24226
- schema:
24227
- $ref: '#/components/schemas/MuteFindingRequest'
24228
- description: 'To mute or unmute a finding, the request body should include
24229
- at least two attributes: `muted` and `reason`. The allowed reasons depend
24230
- on whether the finding is being muted or unmuted:
24231
-
24232
- - To mute a finding: `PENDING_FIX`, `FALSE_POSITIVE`, `ACCEPTED_RISK`, `OTHER`.
24233
-
24234
- - To unmute a finding : `NO_PENDING_FIX`, `HUMAN_ERROR`, `NO_LONGER_ACCEPTED_RISK`,
24235
- `OTHER`.
24236
-
24237
- '
24238
- required: true
24991
+ - description: Return the finding for a given snapshot of time (Unix ms).
24992
+ example: 1678721573794
24993
+ in: query
24994
+ name: snapshot_timestamp
24995
+ required: false
24996
+ schema:
24997
+ format: int64
24998
+ minimum: 1
24999
+ type: integer
24239
25000
  responses:
24240
25001
  '200':
24241
25002
  content:
24242
25003
  application/json:
24243
25004
  schema:
24244
- $ref: '#/components/schemas/MuteFindingResponse'
25005
+ $ref: '#/components/schemas/GetFindingResponse'
24245
25006
  description: OK
24246
25007
  '400':
24247
25008
  $ref: '#/components/responses/FindingsBadRequestResponse'
@@ -24249,29 +25010,16 @@ paths:
24249
25010
  $ref: '#/components/responses/FindingsForbiddenResponse'
24250
25011
  '404':
24251
25012
  $ref: '#/components/responses/FindingsNotFoundResponse'
24252
- '409':
24253
- content:
24254
- application/json:
24255
- schema:
24256
- $ref: '#/components/schemas/JSONAPIErrorResponse'
24257
- description: 'Resource Conflict: The finding has already been muted or unmuted
24258
- within the last 60 seconds.'
24259
- '422':
24260
- content:
24261
- application/json:
24262
- schema:
24263
- $ref: '#/components/schemas/JSONAPIErrorResponse'
24264
- description: 'Invalid Request: The server understands the request syntax
24265
- but cannot process it due to invalid data.'
24266
25013
  '429':
24267
25014
  $ref: '#/components/responses/FindingsTooManyRequestsResponse'
24268
25015
  security:
24269
25016
  - apiKeyAuth: []
24270
25017
  appKeyAuth: []
24271
- summary: Mute or unmute a finding
25018
+ - AuthZ:
25019
+ - security_monitoring_findings_read
25020
+ summary: Get a finding
24272
25021
  tags:
24273
25022
  - Security Monitoring
24274
- x-codegen-request-body-name: body
24275
25023
  x-unstable: '**Note**: This endpoint is in public beta.
24276
25024
 
24277
25025
  If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
@@ -24774,6 +25522,12 @@ paths:
24774
25522
  required: false
24775
25523
  schema:
24776
25524
  type: string
25525
+ - description: Filter all roles by the given list of role IDs.
25526
+ in: query
25527
+ name: filter[id]
25528
+ required: false
25529
+ schema:
25530
+ type: string
24777
25531
  responses:
24778
25532
  '200':
24779
25533
  content:
@@ -25612,6 +26366,291 @@ paths:
25612
26366
  tags:
25613
26367
  - Organizations
25614
26368
  x-codegen-request-body-name: body
26369
+ /api/v2/scorecard/outcomes:
26370
+ get:
26371
+ description: Fetches all rule outcomes.
26372
+ operationId: ListScorecardOutcomes
26373
+ parameters:
26374
+ - $ref: '#/components/parameters/PageSize'
26375
+ - $ref: '#/components/parameters/PageOffset'
26376
+ - description: Include related rule details in the response.
26377
+ in: query
26378
+ name: include
26379
+ required: false
26380
+ schema:
26381
+ example: rule
26382
+ type: string
26383
+ - description: Return only specified values in the outcome attributes.
26384
+ in: query
26385
+ name: fields[outcome]
26386
+ required: false
26387
+ schema:
26388
+ example: state, service_name
26389
+ type: string
26390
+ - description: Return only specified values in the included rule details.
26391
+ in: query
26392
+ name: fields[rule]
26393
+ required: false
26394
+ schema:
26395
+ example: name
26396
+ type: string
26397
+ - description: Filter the outcomes on a specific service name.
26398
+ in: query
26399
+ name: filter[outcome][service_name]
26400
+ required: false
26401
+ schema:
26402
+ example: web-store
26403
+ type: string
26404
+ - description: Filter the outcomes by a specific state.
26405
+ in: query
26406
+ name: filter[outcome][state]
26407
+ required: false
26408
+ schema:
26409
+ example: fail
26410
+ type: string
26411
+ - description: Filter outcomes on whether a rule is enabled/disabled.
26412
+ in: query
26413
+ name: filter[rule][enabled]
26414
+ required: false
26415
+ schema:
26416
+ example: true
26417
+ type: boolean
26418
+ - description: Filter outcomes based on rule ID.
26419
+ in: query
26420
+ name: filter[rule][id]
26421
+ required: false
26422
+ schema:
26423
+ example: f4485c79-0762-449c-96cf-c31e54a659f6
26424
+ type: string
26425
+ - description: Filter outcomes based on rule name.
26426
+ in: query
26427
+ name: filter[rule][name]
26428
+ required: false
26429
+ schema:
26430
+ example: SLOs Defined
26431
+ type: string
26432
+ responses:
26433
+ '200':
26434
+ content:
26435
+ application/json:
26436
+ schema:
26437
+ $ref: '#/components/schemas/OutcomesResponse'
26438
+ description: OK
26439
+ '400':
26440
+ $ref: '#/components/responses/BadRequestResponse'
26441
+ '403':
26442
+ $ref: '#/components/responses/ForbiddenResponse'
26443
+ '429':
26444
+ $ref: '#/components/responses/TooManyRequestsResponse'
26445
+ security:
26446
+ - apiKeyAuth: []
26447
+ appKeyAuth: []
26448
+ - AuthZ:
26449
+ - apm_service_catalog_read
26450
+ summary: List all rule outcomes
26451
+ tags:
26452
+ - Service Scorecards
26453
+ x-pagination:
26454
+ limitParam: page[size]
26455
+ pageOffsetParam: page[offset]
26456
+ resultsPath: data
26457
+ x-unstable: '**Note**: This endpoint is in public beta.
26458
+
26459
+ If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
26460
+ /api/v2/scorecard/outcomes/batch:
26461
+ post:
26462
+ description: Sets multiple service-rule outcomes in a single batched request.
26463
+ operationId: CreateScorecardOutcomesBatch
26464
+ requestBody:
26465
+ content:
26466
+ application/json:
26467
+ schema:
26468
+ $ref: '#/components/schemas/OutcomesBatchRequest'
26469
+ description: Set of scorecard outcomes.
26470
+ required: true
26471
+ responses:
26472
+ '200':
26473
+ content:
26474
+ application/json:
26475
+ schema:
26476
+ $ref: '#/components/schemas/OutcomesBatchResponse'
26477
+ description: OK
26478
+ '400':
26479
+ $ref: '#/components/responses/BadRequestResponse'
26480
+ '403':
26481
+ $ref: '#/components/responses/ForbiddenResponse'
26482
+ '429':
26483
+ $ref: '#/components/responses/TooManyRequestsResponse'
26484
+ security:
26485
+ - apiKeyAuth: []
26486
+ appKeyAuth: []
26487
+ - AuthZ:
26488
+ - apm_service_catalog_write
26489
+ summary: Create outcomes batch
26490
+ tags:
26491
+ - Service Scorecards
26492
+ x-codegen-request-body-name: body
26493
+ x-unstable: '**Note**: This endpoint is in private beta. To request access,
26494
+ fill out this [sign-up form](https://forms.gle/CcEyp1uJmZpxRv8U8),
26495
+
26496
+ and we will be in touch. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
26497
+ /api/v2/scorecard/rules:
26498
+ get:
26499
+ description: Fetch all rules.
26500
+ operationId: ListScorecardRules
26501
+ parameters:
26502
+ - $ref: '#/components/parameters/PageSize'
26503
+ - $ref: '#/components/parameters/PageOffset'
26504
+ - description: Include related scorecard details in the response.
26505
+ in: query
26506
+ name: include
26507
+ required: false
26508
+ schema:
26509
+ example: scorecard
26510
+ type: string
26511
+ - description: Filter the rules on a rule ID.
26512
+ in: query
26513
+ name: filter[rule][id]
26514
+ required: false
26515
+ schema:
26516
+ example: 37d2f990-c885-4972-949b-8b798213a166
26517
+ type: string
26518
+ - description: Filter for enabled rules only.
26519
+ in: query
26520
+ name: filter[rule][enabled]
26521
+ required: false
26522
+ schema:
26523
+ example: true
26524
+ type: boolean
26525
+ - description: Filter for custom rules only.
26526
+ in: query
26527
+ name: filter[rule][custom]
26528
+ required: false
26529
+ schema:
26530
+ example: true
26531
+ type: boolean
26532
+ - description: Filter rules on the rule name.
26533
+ in: query
26534
+ name: filter[rule][name]
26535
+ required: false
26536
+ schema:
26537
+ example: Code Repos Defined
26538
+ type: string
26539
+ - description: Filter rules on the rule description.
26540
+ in: query
26541
+ name: filter[rule][description]
26542
+ required: false
26543
+ schema:
26544
+ example: Identifying
26545
+ type: string
26546
+ - description: Return only specific fields in the response for rule attributes.
26547
+ in: query
26548
+ name: fields[rule]
26549
+ required: false
26550
+ schema:
26551
+ example: name, description
26552
+ type: string
26553
+ - description: Return only specific fields in the included response for scorecard
26554
+ attributes.
26555
+ in: query
26556
+ name: fields[scorecard]
26557
+ required: false
26558
+ schema:
26559
+ example: name
26560
+ type: string
26561
+ responses:
26562
+ '200':
26563
+ content:
26564
+ application/json:
26565
+ schema:
26566
+ $ref: '#/components/schemas/ListRulesResponse'
26567
+ description: OK
26568
+ '400':
26569
+ $ref: '#/components/responses/BadRequestResponse'
26570
+ '403':
26571
+ $ref: '#/components/responses/ForbiddenResponse'
26572
+ '429':
26573
+ $ref: '#/components/responses/TooManyRequestsResponse'
26574
+ security:
26575
+ - apiKeyAuth: []
26576
+ appKeyAuth: []
26577
+ - AuthZ:
26578
+ - apm_service_catalog_read
26579
+ summary: List all rules
26580
+ tags:
26581
+ - Service Scorecards
26582
+ x-pagination:
26583
+ limitParam: page[size]
26584
+ pageOffsetParam: page[offset]
26585
+ resultsPath: data
26586
+ x-unstable: '**Note**: This endpoint is in public beta.
26587
+
26588
+ If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
26589
+ post:
26590
+ description: Creates a new rule.
26591
+ operationId: CreateScorecardRule
26592
+ requestBody:
26593
+ content:
26594
+ application/json:
26595
+ schema:
26596
+ $ref: '#/components/schemas/CreateRuleRequest'
26597
+ description: Rule attributes.
26598
+ required: true
26599
+ responses:
26600
+ '201':
26601
+ content:
26602
+ application/json:
26603
+ schema:
26604
+ $ref: '#/components/schemas/CreateRuleResponse'
26605
+ description: Created
26606
+ '400':
26607
+ $ref: '#/components/responses/BadRequestResponse'
26608
+ '403':
26609
+ $ref: '#/components/responses/ForbiddenResponse'
26610
+ '429':
26611
+ $ref: '#/components/responses/TooManyRequestsResponse'
26612
+ security:
26613
+ - apiKeyAuth: []
26614
+ appKeyAuth: []
26615
+ - AuthZ:
26616
+ - apm_service_catalog_write
26617
+ summary: Create a new rule
26618
+ tags:
26619
+ - Service Scorecards
26620
+ x-codegen-request-body-name: body
26621
+ x-unstable: '**Note**: This endpoint is in private beta. To request access,
26622
+ fill out this [sign-up form](https://forms.gle/CcEyp1uJmZpxRv8U8),
26623
+
26624
+ and we will be in touch. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
26625
+ /api/v2/scorecard/rules/{rule_id}:
26626
+ delete:
26627
+ description: Deletes a single rule.
26628
+ operationId: DeleteScorecardRule
26629
+ parameters:
26630
+ - $ref: '#/components/parameters/RuleId'
26631
+ responses:
26632
+ '204':
26633
+ description: OK
26634
+ '400':
26635
+ $ref: '#/components/responses/BadRequestResponse'
26636
+ '403':
26637
+ $ref: '#/components/responses/ForbiddenResponse'
26638
+ '404':
26639
+ $ref: '#/components/responses/NotFoundResponse'
26640
+ '429':
26641
+ $ref: '#/components/responses/TooManyRequestsResponse'
26642
+ security:
26643
+ - apiKeyAuth: []
26644
+ appKeyAuth: []
26645
+ - AuthZ:
26646
+ - apm_service_catalog_write
26647
+ summary: Delete a rule
26648
+ tags:
26649
+ - Service Scorecards
26650
+ x-unstable: '**Note**: This endpoint is in private beta. To request access,
26651
+ fill out this [sign-up form](https://forms.gle/CcEyp1uJmZpxRv8U8),
26652
+
26653
+ and we will be in touch. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
25615
26654
  /api/v2/security/cloud_workload/policy/download:
25616
26655
  get:
25617
26656
  description: 'The download endpoint generates a Cloud Workload Security policy
@@ -27494,12 +28533,14 @@ paths:
27494
28533
  - description: Specifies the order of the returned teams
27495
28534
  in: query
27496
28535
  name: sort
28536
+ required: false
27497
28537
  schema:
27498
28538
  $ref: '#/components/schemas/ListTeamsSort'
27499
28539
  - description: 'Included related resources optionally requested. Allowed enum
27500
28540
  values: `team_links, user_team_permissions`'
27501
28541
  in: query
27502
28542
  name: include
28543
+ required: false
27503
28544
  schema:
27504
28545
  items:
27505
28546
  $ref: '#/components/schemas/ListTeamsInclude'
@@ -27508,13 +28549,24 @@ paths:
27508
28549
  member
27509
28550
  in: query
27510
28551
  name: filter[keyword]
28552
+ required: false
27511
28553
  schema:
27512
28554
  type: string
27513
28555
  - description: When true, only returns teams the current user belongs to
27514
28556
  in: query
27515
28557
  name: filter[me]
28558
+ required: false
27516
28559
  schema:
27517
28560
  type: boolean
28561
+ - description: List of fields that need to be fetched.
28562
+ explode: false
28563
+ in: query
28564
+ name: fields[team]
28565
+ required: false
28566
+ schema:
28567
+ items:
28568
+ $ref: '#/components/schemas/TeamsField'
28569
+ type: array
27518
28570
  responses:
27519
28571
  '200':
27520
28572
  content:
@@ -27929,11 +28981,13 @@ paths:
27929
28981
  - description: Specifies the order of returned team memberships
27930
28982
  in: query
27931
28983
  name: sort
28984
+ required: false
27932
28985
  schema:
27933
28986
  $ref: '#/components/schemas/GetTeamMembershipsSort'
27934
28987
  - description: Search query, can be user email or name
27935
28988
  in: query
27936
28989
  name: filter[keyword]
28990
+ required: false
27937
28991
  schema:
27938
28992
  type: string
27939
28993
  responses:
@@ -29128,7 +30182,7 @@ paths:
29128
30182
  application/json:
29129
30183
  schema:
29130
30184
  $ref: '#/components/schemas/UserResponse'
29131
- description: OK for get user
30185
+ description: OK
29132
30186
  '403':
29133
30187
  content:
29134
30188
  application/json:
@@ -29384,6 +30438,8 @@ tags:
29384
30438
  - description: The Container Images API allows you to query Container Image data for
29385
30439
  your organization.
29386
30440
  name: Container Images
30441
+ - description: The Containers API allows you to query container data for your organization.
30442
+ name: Containers
29387
30443
  - description: 'Interact with your dashboard lists through the API to
29388
30444
 
29389
30445
  organize, find, and share all of your dashboards with your team and
@@ -29562,6 +30618,12 @@ tags:
29562
30618
  externalDocs:
29563
30619
  url: https://docs.datadoghq.com/tracing/service_catalog/
29564
30620
  name: Service Definition
30621
+ - description: 'API to create, update scorecard rules and outcomes.
30622
+
30623
+
30624
+ This feature is currently in BETA. If you have any feedback, contact [Datadog
30625
+ support](https://docs.datadoghq.com/help/).'
30626
+ name: Service Scorecards
29565
30627
  - description: Search and aggregate your spans from your Datadog platform over HTTP.
29566
30628
  name: Spans
29567
30629
  - description: Manage configuration of [span-based metrics](https://app.datadoghq.com/apm/traces/generate-metrics)