datadog_api_client 2.21.0 → 2.22.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (102) hide show
  1. checksums.yaml +4 -4
  2. data/.apigentools-info +4 -4
  3. data/.generator/schemas/v1/openapi.yaml +180 -637
  4. data/.generator/schemas/v2/openapi.yaml +515 -33
  5. data/.github/workflows/prepare_release.yml +2 -2
  6. data/.github/workflows/publish.yml +2 -2
  7. data/.github/workflows/release.yml +2 -2
  8. data/.github/workflows/test.yml +1 -1
  9. data/CHANGELOG.md +24 -0
  10. data/Gemfile +1 -1
  11. data/examples/v1/aws-integration/CreateAWSAccount.rb +1 -1
  12. data/examples/v1/aws-integration/CreateNewAWSExternalID.rb +1 -0
  13. data/examples/v1/aws-integration/UpdateAWSAccount.rb +1 -1
  14. data/examples/v1/synthetics/CreateSyntheticsAPITest_1241981394.rb +118 -0
  15. data/examples/v1/synthetics/UpdateBrowserTest.rb +3 -0
  16. data/examples/v2/apm-retention-filters/UpdateApmRetentionFilter.rb +2 -2
  17. data/examples/v2/authn-mappings/CreateAuthNMapping.rb +1 -1
  18. data/examples/v2/authn-mappings/UpdateAuthNMapping.rb +1 -1
  19. data/examples/v2/cloud-workload-security/CreateCSMThreatsAgentRule.rb +1 -1
  20. data/examples/v2/gcp-integration/CreateGCPSTSAccount.rb +1 -1
  21. data/examples/v2/gcp-integration/CreateGCPSTSAccount_109518525.rb +1 -1
  22. data/examples/v2/gcp-integration/CreateGCPSTSAccount_130557025.rb +1 -1
  23. data/examples/v2/gcp-integration/CreateGCPSTSAccount_194782945.rb +1 -1
  24. data/examples/v2/gcp-integration/CreateGCPSTSAccount_2597004741.rb +1 -1
  25. data/examples/v2/gcp-integration/CreateGCPSTSAccount_4235664992.rb +1 -1
  26. data/examples/v2/gcp-integration/UpdateGCPSTSAccount.rb +1 -1
  27. data/examples/v2/gcp-integration/UpdateGCPSTSAccount_2241994060.rb +1 -1
  28. data/examples/v2/gcp-integration/UpdateGCPSTSAccount_3205636354.rb +1 -1
  29. data/examples/v2/logs-custom-destinations/UpdateLogsCustomDestination.rb +4 -0
  30. data/examples/v2/metrics/QueryScalarData_3112571352.rb +2 -2
  31. data/examples/v2/metrics/QueryTimeseriesData_301142940.rb +3 -3
  32. data/examples/v2/security-monitoring/CreateSecurityMonitoringSuppression_3192265332.rb +19 -0
  33. data/examples/v2/security-monitoring/ValidateSecurityMonitoringRule.rb +42 -0
  34. data/examples/v2/service-definition/CreateOrUpdateServiceDefinitions.rb +4 -0
  35. data/examples/v2/service-level-objectives/CreateSLOReportJob.rb +20 -0
  36. data/examples/v2/service-level-objectives/GetSLOReport.rb +8 -0
  37. data/examples/v2/service-level-objectives/GetSLOReportJobStatus.rb +11 -0
  38. data/lib/datadog_api_client/configuration.rb +3 -0
  39. data/lib/datadog_api_client/inflector.rb +20 -7
  40. data/lib/datadog_api_client/v1/api/usage_metering_api.rb +104 -131
  41. data/lib/datadog_api_client/v1/models/aws_account.rb +12 -2
  42. data/lib/datadog_api_client/v1/models/hourly_usage_attribution_usage_type.rb +2 -0
  43. data/lib/datadog_api_client/v1/models/monitor_options.rb +4 -1
  44. data/lib/datadog_api_client/v1/models/monthly_usage_attribution_supported_metrics.rb +4 -0
  45. data/lib/datadog_api_client/v1/models/monthly_usage_attribution_values.rb +41 -1
  46. data/lib/datadog_api_client/v1/models/series.rb +1 -1
  47. data/lib/datadog_api_client/v1/models/slo_time_slice_condition.rb +14 -2
  48. data/lib/datadog_api_client/v1/models/slo_time_slice_interval.rb +29 -0
  49. data/lib/datadog_api_client/v1/models/slo_time_slice_spec.rb +1 -1
  50. data/lib/datadog_api_client/v1/models/synthetics_test_request.rb +13 -1
  51. data/lib/datadog_api_client/v1/models/synthetics_test_request_body_file.rb +175 -0
  52. data/lib/datadog_api_client/v1/models/synthetics_test_request_body_type.rb +2 -0
  53. data/lib/datadog_api_client/v2/api/apm_retention_filters_api.rb +6 -0
  54. data/lib/datadog_api_client/v2/api/metrics_api.rb +1 -1
  55. data/lib/datadog_api_client/v2/api/security_monitoring_api.rb +67 -0
  56. data/lib/datadog_api_client/v2/api/service_level_objectives_api.rb +245 -0
  57. data/lib/datadog_api_client/v2/api/usage_metering_api.rb +12 -3
  58. data/lib/datadog_api_client/v2/models/authn_mapping_create_data.rb +1 -1
  59. data/lib/datadog_api_client/v2/models/authn_mapping_create_relationships.rb +37 -54
  60. data/lib/datadog_api_client/v2/models/authn_mapping_included.rb +2 -1
  61. data/lib/datadog_api_client/v2/models/authn_mapping_relationship_to_role.rb +98 -0
  62. data/lib/datadog_api_client/v2/models/authn_mapping_relationship_to_team.rb +98 -0
  63. data/lib/datadog_api_client/v2/models/authn_mapping_relationships.rb +14 -4
  64. data/lib/datadog_api_client/{v1/models/usage_attribution_metadata.rb → v2/models/authn_mapping_team.rb} +31 -23
  65. data/lib/datadog_api_client/v2/models/authn_mapping_team_attributes.rb +212 -0
  66. data/lib/datadog_api_client/v2/models/authn_mapping_update_data.rb +1 -1
  67. data/lib/datadog_api_client/v2/models/authn_mapping_update_relationships.rb +37 -54
  68. data/lib/datadog_api_client/v2/models/custom_destination_type.rb +1 -1
  69. data/lib/datadog_api_client/v2/models/dora_deployment_request_attributes.rb +1 -1
  70. data/lib/datadog_api_client/v2/models/metric_series.rb +1 -1
  71. data/lib/datadog_api_client/v2/models/relationship_to_team.rb +80 -0
  72. data/lib/datadog_api_client/{v1/models/usage_attribution_response.rb → v2/models/relationship_to_team_data.rb} +21 -23
  73. data/lib/datadog_api_client/v2/models/retention_filter_update_attributes.rb +183 -0
  74. data/lib/datadog_api_client/v2/models/retention_filter_update_data.rb +1 -1
  75. data/lib/datadog_api_client/v2/models/security_monitoring_rule_update_payload.rb +1 -1
  76. data/lib/datadog_api_client/v2/models/security_monitoring_signal_rule_create_payload.rb +1 -1
  77. data/lib/datadog_api_client/v2/models/security_monitoring_signal_rule_response.rb +1 -1
  78. data/lib/datadog_api_client/v2/models/security_monitoring_standard_rule_create_payload.rb +1 -1
  79. data/lib/datadog_api_client/v2/models/security_monitoring_standard_rule_response.rb +1 -1
  80. data/lib/datadog_api_client/v2/models/security_monitoring_suppression_attributes.rb +11 -1
  81. data/lib/datadog_api_client/v2/models/security_monitoring_suppression_create_attributes.rb +13 -14
  82. data/lib/datadog_api_client/v2/models/security_monitoring_suppression_update_attributes.rb +11 -1
  83. data/lib/datadog_api_client/v2/models/service_definition_v2_dot2.rb +13 -1
  84. data/lib/datadog_api_client/v2/models/slo_report_create_request.rb +98 -0
  85. data/lib/datadog_api_client/v2/models/slo_report_create_request_attributes.rb +160 -0
  86. data/lib/datadog_api_client/{v1/models/usage_attribution_pagination.rb → v2/models/slo_report_create_request_data.rb} +29 -51
  87. data/lib/datadog_api_client/v2/models/slo_report_interval.rb +27 -0
  88. data/lib/datadog_api_client/v2/models/slo_report_post_response.rb +80 -0
  89. data/lib/datadog_api_client/v2/models/slo_report_post_response_data.rb +90 -0
  90. data/lib/datadog_api_client/v2/models/slo_report_status.rb +29 -0
  91. data/lib/datadog_api_client/v2/models/slo_report_status_get_response.rb +80 -0
  92. data/lib/datadog_api_client/v2/models/slo_report_status_get_response_attributes.rb +80 -0
  93. data/lib/datadog_api_client/v2/models/slo_report_status_get_response_data.rb +100 -0
  94. data/lib/datadog_api_client/v2/models/timeseries_response_series.rb +8 -0
  95. data/lib/datadog_api_client/v2/models/user_teams_response.rb +13 -1
  96. data/lib/datadog_api_client/version.rb +1 -1
  97. metadata +51 -33
  98. data/examples/v1/usage-metering/GetUsageAttribution.rb +0 -9
  99. data/lib/datadog_api_client/v1/models/usage_attribution_body.rb +0 -152
  100. data/lib/datadog_api_client/v1/models/usage_attribution_sort.rb +0 -63
  101. data/lib/datadog_api_client/v1/models/usage_attribution_supported_metrics.rb +0 -74
  102. data/lib/datadog_api_client/v1/models/usage_attribution_values.rb +0 -590
@@ -411,6 +411,13 @@ components:
411
411
  required: true
412
412
  schema:
413
413
  type: string
414
+ ReportID:
415
+ description: The ID of the report job.
416
+ in: path
417
+ name: report_id
418
+ required: true
419
+ schema:
420
+ type: string
414
421
  ResourceID:
415
422
  description: 'Identifier, formatted as `type:id`. Supported types: `connection`,
416
423
  `dashboard`, `notebook`, `security-rule`, `slo`.'
@@ -1325,11 +1332,10 @@ components:
1325
1332
  - type
1326
1333
  type: object
1327
1334
  AuthNMappingCreateRelationships:
1328
- description: Relationship of AuthN Mapping create object to Role.
1329
- properties:
1330
- role:
1331
- $ref: '#/components/schemas/RelationshipToRole'
1332
- type: object
1335
+ description: Relationship of AuthN Mapping create object to a Role or Team.
1336
+ oneOf:
1337
+ - $ref: '#/components/schemas/AuthNMappingRelationshipToRole'
1338
+ - $ref: '#/components/schemas/AuthNMappingRelationshipToTeam'
1333
1339
  AuthNMappingCreateRequest:
1334
1340
  description: Request for creating an AuthN Mapping.
1335
1341
  properties:
@@ -1343,6 +1349,23 @@ components:
1343
1349
  oneOf:
1344
1350
  - $ref: '#/components/schemas/SAMLAssertionAttribute'
1345
1351
  - $ref: '#/components/schemas/Role'
1352
+ - $ref: '#/components/schemas/AuthNMappingTeam'
1353
+ AuthNMappingRelationshipToRole:
1354
+ description: Relationship of AuthN Mapping to a Role.
1355
+ properties:
1356
+ role:
1357
+ $ref: '#/components/schemas/RelationshipToRole'
1358
+ required:
1359
+ - role
1360
+ type: object
1361
+ AuthNMappingRelationshipToTeam:
1362
+ description: Relationship of AuthN Mapping to a Team.
1363
+ properties:
1364
+ team:
1365
+ $ref: '#/components/schemas/RelationshipToTeam'
1366
+ required:
1367
+ - team
1368
+ type: object
1346
1369
  AuthNMappingRelationships:
1347
1370
  description: All relationships associated with AuthN Mapping.
1348
1371
  properties:
@@ -1350,6 +1373,8 @@ components:
1350
1373
  $ref: '#/components/schemas/RelationshipToRole'
1351
1374
  saml_assertion_attribute:
1352
1375
  $ref: '#/components/schemas/RelationshipToSAMLAssertionAttribute'
1376
+ team:
1377
+ $ref: '#/components/schemas/RelationshipToTeam'
1353
1378
  type: object
1354
1379
  AuthNMappingResponse:
1355
1380
  description: AuthN Mapping response from the API.
@@ -1362,6 +1387,60 @@ components:
1362
1387
  $ref: '#/components/schemas/AuthNMappingIncluded'
1363
1388
  type: array
1364
1389
  type: object
1390
+ AuthNMappingTeam:
1391
+ description: Team.
1392
+ properties:
1393
+ attributes:
1394
+ $ref: '#/components/schemas/AuthNMappingTeamAttributes'
1395
+ id:
1396
+ description: The ID of the Team.
1397
+ example: f9bb8444-af7f-11ec-ac2c-da7ad0900001
1398
+ type: string
1399
+ type:
1400
+ $ref: '#/components/schemas/TeamType'
1401
+ type: object
1402
+ AuthNMappingTeamAttributes:
1403
+ description: Team attributes.
1404
+ properties:
1405
+ avatar:
1406
+ description: Unicode representation of the avatar for the team, limited
1407
+ to a single grapheme
1408
+ example: "\U0001F951"
1409
+ nullable: true
1410
+ type: string
1411
+ banner:
1412
+ description: Banner selection for the team
1413
+ format: int64
1414
+ nullable: true
1415
+ type: integer
1416
+ handle:
1417
+ description: The team's identifier
1418
+ example: example-team
1419
+ maxLength: 195
1420
+ type: string
1421
+ link_count:
1422
+ description: The number of links belonging to the team
1423
+ format: int32
1424
+ maximum: 2147483647
1425
+ readOnly: true
1426
+ type: integer
1427
+ name:
1428
+ description: The name of the team
1429
+ example: Example Team
1430
+ maxLength: 200
1431
+ type: string
1432
+ summary:
1433
+ description: A brief summary of the team, derived from the `description`
1434
+ maxLength: 120
1435
+ nullable: true
1436
+ type: string
1437
+ user_count:
1438
+ description: The number of users belonging to the team
1439
+ format: int32
1440
+ maximum: 2147483647
1441
+ readOnly: true
1442
+ type: integer
1443
+ type: object
1365
1444
  AuthNMappingUpdateAttributes:
1366
1445
  description: Key/Value pair of attributes used for update request.
1367
1446
  properties:
@@ -1394,11 +1473,10 @@ components:
1394
1473
  - type
1395
1474
  type: object
1396
1475
  AuthNMappingUpdateRelationships:
1397
- description: Relationship of AuthN Mapping update object to Role.
1398
- properties:
1399
- role:
1400
- $ref: '#/components/schemas/RelationshipToRole'
1401
- type: object
1476
+ description: Relationship of AuthN Mapping update object to a Role or Team.
1477
+ oneOf:
1478
+ - $ref: '#/components/schemas/AuthNMappingRelationshipToRole'
1479
+ - $ref: '#/components/schemas/AuthNMappingRelationshipToTeam'
1402
1480
  AuthNMappingUpdateRequest:
1403
1481
  description: Request to update an AuthN Mapping.
1404
1482
  properties:
@@ -5885,7 +5963,7 @@ components:
5885
5963
  example: custom_destination
5886
5964
  type: string
5887
5965
  x-enum-varnames:
5888
- - custom_destination
5966
+ - CUSTOM_DESTINATION
5889
5967
  CustomDestinationUpdateRequest:
5890
5968
  description: The custom destination.
5891
5969
  properties:
@@ -5980,7 +6058,7 @@ components:
5980
6058
  type: string
5981
6059
  finished_at:
5982
6060
  description: Unix timestamp in nanoseconds when the deployment finished.
5983
- It should not be older than 3 hours.
6061
+ It should not be older than 1 hour.
5984
6062
  example: 1693491984000000000
5985
6063
  format: int64
5986
6064
  type: integer
@@ -12444,7 +12522,7 @@ components:
12444
12522
  properties:
12445
12523
  interval:
12446
12524
  description: If the type of the metric is rate or count, define the corresponding
12447
- interval.
12525
+ interval in seconds.
12448
12526
  example: 20
12449
12527
  format: int64
12450
12528
  type: integer
@@ -15667,6 +15745,22 @@ components:
15667
15745
  - id
15668
15746
  - type
15669
15747
  type: object
15748
+ RelationshipToTeam:
15749
+ description: Relationship to team.
15750
+ properties:
15751
+ data:
15752
+ $ref: '#/components/schemas/RelationshipToTeamData'
15753
+ type: object
15754
+ RelationshipToTeamData:
15755
+ description: Relationship to Team object.
15756
+ properties:
15757
+ id:
15758
+ description: The unique identifier of the team.
15759
+ example: f9bb8444-af7f-11ec-ac2c-da7ad0900001
15760
+ type: string
15761
+ type:
15762
+ $ref: '#/components/schemas/TeamType'
15763
+ type: object
15670
15764
  RelationshipToTeamLinkData:
15671
15765
  description: Relationship between a link and a team
15672
15766
  properties:
@@ -15978,6 +16072,7 @@ components:
15978
16072
  - spans-sampling-processor
15979
16073
  - spans-errors-sampling-processor
15980
16074
  - spans-appsec-sampling-processor
16075
+ example: spans-sampling-processor
15981
16076
  type: string
15982
16077
  x-enum-varnames:
15983
16078
  - SPANS_SAMPLING_PROCESSOR
@@ -16094,11 +16189,42 @@ components:
16094
16189
  type: string
16095
16190
  x-enum-varnames:
16096
16191
  - SPANS_SAMPLING_PROCESSOR
16192
+ RetentionFilterUpdateAttributes:
16193
+ description: The object describing the configuration of the retention filter
16194
+ to create/update.
16195
+ properties:
16196
+ enabled:
16197
+ description: Enable/Disable the retention filter.
16198
+ example: true
16199
+ type: boolean
16200
+ filter:
16201
+ $ref: '#/components/schemas/SpansFilterCreate'
16202
+ filter_type:
16203
+ $ref: '#/components/schemas/RetentionFilterAllType'
16204
+ name:
16205
+ description: The name of the retention filter.
16206
+ example: my retention filter
16207
+ type: string
16208
+ rate:
16209
+ description: 'Sample rate to apply to spans going through this retention
16210
+ filter,
16211
+
16212
+ a value of 1.0 keeps all spans matching the query.'
16213
+ example: 1.0
16214
+ format: double
16215
+ type: number
16216
+ required:
16217
+ - name
16218
+ - filter
16219
+ - enabled
16220
+ - filter_type
16221
+ - rate
16222
+ type: object
16097
16223
  RetentionFilterUpdateData:
16098
16224
  description: The body of the retention filter to be updated.
16099
16225
  properties:
16100
16226
  attributes:
16101
- $ref: '#/components/schemas/RetentionFilterCreateAttributes'
16227
+ $ref: '#/components/schemas/RetentionFilterUpdateAttributes'
16102
16228
  id:
16103
16229
  description: The ID of the retention filter.
16104
16230
  example: retention-filter-id
@@ -16487,6 +16613,74 @@ components:
16487
16613
  type: string
16488
16614
  x-enum-varnames:
16489
16615
  - SAML_ASSERTION_ATTRIBUTES
16616
+ SLOReportInterval:
16617
+ description: The frequency at which report data is to be generated.
16618
+ enum:
16619
+ - weekly
16620
+ - monthly
16621
+ example: weekly
16622
+ type: string
16623
+ x-enum-varnames:
16624
+ - WEEKLY
16625
+ - MONTHLY
16626
+ SLOReportPostResponse:
16627
+ description: The SLO report response.
16628
+ properties:
16629
+ data:
16630
+ $ref: '#/components/schemas/SLOReportPostResponseData'
16631
+ type: object
16632
+ SLOReportPostResponseData:
16633
+ description: The data portion of the SLO report response.
16634
+ properties:
16635
+ id:
16636
+ description: The ID of the report job.
16637
+ example: dc8d92aa-e0af-11ee-af21-1feeaccaa3a3
16638
+ type: string
16639
+ type:
16640
+ description: The type of ID.
16641
+ example: report_id
16642
+ type: string
16643
+ type: object
16644
+ SLOReportStatus:
16645
+ description: The status of the SLO report job.
16646
+ enum:
16647
+ - in_progress
16648
+ - completed
16649
+ - completed_with_errors
16650
+ - failed
16651
+ example: completed
16652
+ type: string
16653
+ x-enum-varnames:
16654
+ - IN_PROGRESS
16655
+ - COMPLETED
16656
+ - COMPLETED_WITH_ERRORS
16657
+ - FAILED
16658
+ SLOReportStatusGetResponse:
16659
+ description: The SLO report status response.
16660
+ properties:
16661
+ data:
16662
+ $ref: '#/components/schemas/SLOReportStatusGetResponseData'
16663
+ type: object
16664
+ SLOReportStatusGetResponseAttributes:
16665
+ description: The attributes portion of the SLO report status response.
16666
+ properties:
16667
+ status:
16668
+ $ref: '#/components/schemas/SLOReportStatus'
16669
+ type: object
16670
+ SLOReportStatusGetResponseData:
16671
+ description: The data portion of the SLO report status response.
16672
+ properties:
16673
+ attributes:
16674
+ $ref: '#/components/schemas/SLOReportStatusGetResponseAttributes'
16675
+ id:
16676
+ description: The ID of the report job.
16677
+ example: dc8d92aa-e0af-11ee-af21-1feeaccaa3a3
16678
+ type: string
16679
+ type:
16680
+ description: The type of ID.
16681
+ example: report_id
16682
+ type: string
16683
+ type: object
16490
16684
  ScalarColumn:
16491
16685
  description: A single column in a scalar query response.
16492
16686
  oneOf:
@@ -17283,7 +17477,8 @@ components:
17283
17477
  $ref: '#/components/schemas/CloudConfigurationRuleComplianceSignalOptions'
17284
17478
  filters:
17285
17479
  description: Additional queries to filter matched events before they are
17286
- processed.
17480
+ processed. This field is deprecated for log detection, signal correlation,
17481
+ and workload security rules.
17287
17482
  items:
17288
17483
  $ref: '#/components/schemas/SecurityMonitoringFilter'
17289
17484
  type: array
@@ -17531,7 +17726,8 @@ components:
17531
17726
  type: array
17532
17727
  filters:
17533
17728
  description: Additional queries to filter matched events before they are
17534
- processed.
17729
+ processed. This field is deprecated for log detection, signal correlation,
17730
+ and workload security rules.
17535
17731
  items:
17536
17732
  $ref: '#/components/schemas/SecurityMonitoringFilter'
17537
17733
  type: array
@@ -17633,7 +17829,8 @@ components:
17633
17829
  type: integer
17634
17830
  filters:
17635
17831
  description: Additional queries to filter matched events before they are
17636
- processed.
17832
+ processed. This field is deprecated for log detection, signal correlation,
17833
+ and workload security rules.
17637
17834
  items:
17638
17835
  $ref: '#/components/schemas/SecurityMonitoringFilter'
17639
17836
  type: array
@@ -17912,7 +18109,8 @@ components:
17912
18109
  type: array
17913
18110
  filters:
17914
18111
  description: Additional queries to filter matched events before they are
17915
- processed.
18112
+ processed. This field is deprecated for log detection, signal correlation,
18113
+ and workload security rules.
17916
18114
  items:
17917
18115
  $ref: '#/components/schemas/SecurityMonitoringFilter'
17918
18116
  type: array
@@ -18039,7 +18237,8 @@ components:
18039
18237
  type: integer
18040
18238
  filters:
18041
18239
  description: Additional queries to filter matched events before they are
18042
- processed.
18240
+ processed. This field is deprecated for log detection, signal correlation,
18241
+ and workload security rules.
18043
18242
  items:
18044
18243
  $ref: '#/components/schemas/SecurityMonitoringFilter'
18045
18244
  type: array
@@ -18115,6 +18314,13 @@ components:
18115
18314
  type: integer
18116
18315
  creator:
18117
18316
  $ref: '#/components/schemas/SecurityMonitoringUser'
18317
+ data_exclusion_query:
18318
+ description: An exclusion query on the input data of the security rules,
18319
+ which could be logs, Agent events, or other types of data based on the
18320
+ security rule. Events matching this query are ignored by any detection
18321
+ rules referenced in the suppression rule.
18322
+ example: source:cloudtrail account_id:12345
18323
+ type: string
18118
18324
  description:
18119
18325
  description: A description for the suppression rule.
18120
18326
  example: This rule suppresses low-severity signals in staging environments.
@@ -18163,6 +18369,13 @@ components:
18163
18369
  description: Object containing the attributes of the suppression rule to be
18164
18370
  created.
18165
18371
  properties:
18372
+ data_exclusion_query:
18373
+ description: An exclusion query on the input data of the security rules,
18374
+ which could be logs, Agent events, or other types of data based on the
18375
+ security rule. Events matching this query are ignored by any detection
18376
+ rules referenced in the suppression rule.
18377
+ example: source:cloudtrail account_id:12345
18378
+ type: string
18166
18379
  description:
18167
18380
  description: A description for the suppression rule.
18168
18381
  example: This rule suppresses low-severity signals in staging environments.
@@ -18188,15 +18401,14 @@ components:
18188
18401
  type: string
18189
18402
  suppression_query:
18190
18403
  description: The suppression query of the suppression rule. If a signal
18191
- matches this query, it is suppressed and is not triggered . Same syntax
18192
- as the queries to search signals in the signal explorer.
18404
+ matches this query, it is suppressed and is not triggered. It uses the
18405
+ same syntax as the queries to search signals in the Signals Explorer.
18193
18406
  example: env:staging status:low
18194
18407
  type: string
18195
18408
  required:
18196
18409
  - name
18197
18410
  - enabled
18198
18411
  - rule_query
18199
- - suppression_query
18200
18412
  type: object
18201
18413
  SecurityMonitoringSuppressionCreateData:
18202
18414
  description: Object for a single suppression rule.
@@ -18240,6 +18452,13 @@ components:
18240
18452
  SecurityMonitoringSuppressionUpdateAttributes:
18241
18453
  description: The suppression rule properties to be updated.
18242
18454
  properties:
18455
+ data_exclusion_query:
18456
+ description: An exclusion query on the input data of the security rules,
18457
+ which could be logs, Agent events, or other types of data based on the
18458
+ security rule. Events matching this query are ignored by any detection
18459
+ rules referenced in the suppression rule.
18460
+ example: source:cloudtrail account_id:12345
18461
+ type: string
18243
18462
  description:
18244
18463
  description: A description for the suppression rule.
18245
18464
  example: This rule suppresses low-severity signals in staging environments.
@@ -19683,6 +19902,14 @@ components:
19683
19902
  feature, which the service is a part of.
19684
19903
  example: my-app
19685
19904
  type: string
19905
+ ci-pipeline-fingerprints:
19906
+ description: A set of CI fingerprints.
19907
+ example:
19908
+ - j88xdEy0J5lc
19909
+ - eZ7LMljCk8vo
19910
+ items:
19911
+ type: string
19912
+ type: array
19686
19913
  contacts:
19687
19914
  description: A list of contacts related to the services.
19688
19915
  items:
@@ -20116,6 +20343,53 @@ components:
20116
20343
  - channel_name
20117
20344
  - redirect_url
20118
20345
  type: object
20346
+ SloReportCreateRequest:
20347
+ description: The SLO report request body.
20348
+ properties:
20349
+ data:
20350
+ $ref: '#/components/schemas/SloReportCreateRequestData'
20351
+ required:
20352
+ - data
20353
+ type: object
20354
+ SloReportCreateRequestAttributes:
20355
+ description: The attributes portion of the SLO report request.
20356
+ properties:
20357
+ from_ts:
20358
+ description: The `from` timestamp for the report in epoch seconds.
20359
+ example: 1690901870
20360
+ format: int64
20361
+ type: integer
20362
+ interval:
20363
+ $ref: '#/components/schemas/SLOReportInterval'
20364
+ query:
20365
+ description: The query string used to filter SLO results. Some examples
20366
+ of queries include `service:<service-name>` and `slo-name`.
20367
+ example: slo_type:metric
20368
+ type: string
20369
+ timezone:
20370
+ description: The timezone used to determine the start and end of each interval.
20371
+ For example, weekly intervals start at 12am on Sunday in the specified
20372
+ timezone.
20373
+ example: America/New_York
20374
+ type: string
20375
+ to_ts:
20376
+ description: The `to` timestamp for the report in epoch seconds.
20377
+ example: 1706803070
20378
+ format: int64
20379
+ type: integer
20380
+ required:
20381
+ - query
20382
+ - from_ts
20383
+ - to_ts
20384
+ type: object
20385
+ SloReportCreateRequestData:
20386
+ description: The data portion of the SLO report request.
20387
+ properties:
20388
+ attributes:
20389
+ $ref: '#/components/schemas/SloReportCreateRequestAttributes'
20390
+ required:
20391
+ - attributes
20392
+ type: object
20119
20393
  SortDirection:
20120
20394
  default: desc
20121
20395
  description: The direction to sort by.
@@ -21734,6 +22008,7 @@ components:
21734
22008
  If the second element is not present, the API returns null.'
21735
22009
  items:
21736
22010
  $ref: '#/components/schemas/Unit'
22011
+ nullable: true
21737
22012
  type: array
21738
22013
  type: object
21739
22014
  TimeseriesResponseSeriesList:
@@ -22312,6 +22587,11 @@ components:
22312
22587
  items:
22313
22588
  $ref: '#/components/schemas/UserTeam'
22314
22589
  type: array
22590
+ included:
22591
+ description: Resources related to the team memberships
22592
+ items:
22593
+ $ref: '#/components/schemas/UserTeamIncluded'
22594
+ type: array
22315
22595
  links:
22316
22596
  $ref: '#/components/schemas/TeamsResponseLinks'
22317
22597
  meta:
@@ -23023,7 +23303,11 @@ paths:
23023
23303
  post:
23024
23304
  description: 'Create a retention filter to index spans in your organization.
23025
23305
 
23026
- Returns the retention filter definition when the request is successful.'
23306
+ Returns the retention filter definition when the request is successful.
23307
+
23308
+
23309
+ Default filters with types spans-errors-sampling-processor and spans-appsec-sampling-processor
23310
+ cannot be created.'
23027
23311
  operationId: CreateApmRetentionFilter
23028
23312
  requestBody:
23029
23313
  content:
@@ -23077,7 +23361,11 @@ paths:
23077
23361
  x-codegen-request-body-name: body
23078
23362
  /api/v2/apm/config/retention-filters/{filter_id}:
23079
23363
  delete:
23080
- description: Delete a specific retention filter from your organization.
23364
+ description: 'Delete a specific retention filter from your organization.
23365
+
23366
+
23367
+ Default filters with types spans-errors-sampling-processor and spans-appsec-sampling-processor
23368
+ cannot be deleted.'
23081
23369
  operationId: DeleteApmRetentionFilter
23082
23370
  parameters:
23083
23371
  - $ref: '#/components/parameters/RetentionFilterIdParam'
@@ -23115,7 +23403,11 @@ paths:
23115
23403
  tags:
23116
23404
  - APM Retention Filters
23117
23405
  put:
23118
- description: Update a retention filter from your organization.
23406
+ description: 'Update a retention filter from your organization.
23407
+
23408
+
23409
+ Default filters (filters with types spans-errors-sampling-processor and spans-appsec-sampling-processor)
23410
+ cannot be renamed or removed.'
23119
23411
  operationId: UpdateApmRetentionFilter
23120
23412
  parameters:
23121
23413
  - $ref: '#/components/parameters/RetentionFilterIdParam'
@@ -29016,8 +29308,8 @@ paths:
29016
29308
  x-codegen-request-body-name: body
29017
29309
  /api/v2/metrics/{metric_name}/active-configurations:
29018
29310
  get:
29019
- description: List tags and aggregations that are actively queried on dashboards
29020
- and monitors for a given metric name.
29311
+ description: List tags and aggregations that are actively queried on dashboards,
29312
+ notebooks, monitors, and the Metrics Explorer for a given metric name.
29021
29313
  operationId: ListActiveMetricConfigurations
29022
29314
  parameters:
29023
29315
  - $ref: '#/components/parameters/MetricName'
@@ -32274,6 +32566,34 @@ paths:
32274
32566
  tags:
32275
32567
  - Security Monitoring
32276
32568
  x-codegen-request-body-name: body
32569
+ /api/v2/security_monitoring/rules/validation:
32570
+ post:
32571
+ description: Validate a detection rule.
32572
+ operationId: ValidateSecurityMonitoringRule
32573
+ requestBody:
32574
+ content:
32575
+ application/json:
32576
+ schema:
32577
+ $ref: '#/components/schemas/SecurityMonitoringRuleCreatePayload'
32578
+ required: true
32579
+ responses:
32580
+ '204':
32581
+ description: OK
32582
+ '400':
32583
+ $ref: '#/components/responses/BadRequestResponse'
32584
+ '403':
32585
+ $ref: '#/components/responses/NotAuthorizedResponse'
32586
+ '429':
32587
+ $ref: '#/components/responses/TooManyRequestsResponse'
32588
+ security:
32589
+ - apiKeyAuth: []
32590
+ appKeyAuth: []
32591
+ - AuthZ:
32592
+ - security_monitoring_rules_write
32593
+ summary: Validate a detection rule
32594
+ tags:
32595
+ - Security Monitoring
32596
+ x-codegen-request-body-name: body
32277
32597
  /api/v2/security_monitoring/rules/{rule_id}:
32278
32598
  delete:
32279
32599
  description: Delete an existing rule. Default rules cannot be deleted.
@@ -33581,6 +33901,149 @@ paths:
33581
33901
  - Incident Services
33582
33902
  x-codegen-request-body-name: body
33583
33903
  x-unstable: '**Note**: This endpoint is deprecated.'
33904
+ /api/v2/slo/report:
33905
+ post:
33906
+ description: 'Create a job to generate an SLO report. The report job is processed
33907
+ asynchronously and eventually results in a CSV report being available for
33908
+ download.
33909
+
33910
+
33911
+ Check the status of the job and download the CSV report using the returned
33912
+ `report_id`.'
33913
+ operationId: CreateSLOReportJob
33914
+ requestBody:
33915
+ content:
33916
+ application/json:
33917
+ schema:
33918
+ $ref: '#/components/schemas/SloReportCreateRequest'
33919
+ description: Create SLO report job request body.
33920
+ required: true
33921
+ responses:
33922
+ '200':
33923
+ content:
33924
+ application/json:
33925
+ schema:
33926
+ $ref: '#/components/schemas/SLOReportPostResponse'
33927
+ description: OK
33928
+ '400':
33929
+ content:
33930
+ application/json:
33931
+ schema:
33932
+ $ref: '#/components/schemas/APIErrorResponse'
33933
+ description: Bad Request
33934
+ '403':
33935
+ content:
33936
+ application/json:
33937
+ schema:
33938
+ $ref: '#/components/schemas/APIErrorResponse'
33939
+ description: Forbidden
33940
+ '429':
33941
+ $ref: '#/components/responses/TooManyRequestsResponse'
33942
+ security:
33943
+ - apiKeyAuth: []
33944
+ appKeyAuth: []
33945
+ - AuthZ:
33946
+ - slos_read
33947
+ summary: Create a new SLO report
33948
+ tags:
33949
+ - Service Level Objectives
33950
+ x-codegen-request-body-name: body
33951
+ x-unstable: '**Note**: This feature is in private beta. To request access, use
33952
+ the request access form in the [Service Level Objectives](https://docs.datadoghq.com/service_management/service_level_objectives/#slo-csv-export)
33953
+ docs.'
33954
+ /api/v2/slo/report/{report_id}/download:
33955
+ get:
33956
+ description: 'Download an SLO report. This can only be performed after the report
33957
+ job has completed.
33958
+
33959
+
33960
+ Reports are not guaranteed to exist indefinitely. Datadog recommends that
33961
+ you download the report as soon as it is available.'
33962
+ operationId: GetSLOReport
33963
+ parameters:
33964
+ - $ref: '#/components/parameters/ReportID'
33965
+ responses:
33966
+ '200':
33967
+ content:
33968
+ text/csv:
33969
+ schema:
33970
+ type: string
33971
+ description: OK
33972
+ '400':
33973
+ content:
33974
+ application/json:
33975
+ schema:
33976
+ $ref: '#/components/schemas/APIErrorResponse'
33977
+ description: Bad Request
33978
+ '403':
33979
+ content:
33980
+ application/json:
33981
+ schema:
33982
+ $ref: '#/components/schemas/APIErrorResponse'
33983
+ description: Forbidden
33984
+ '404':
33985
+ content:
33986
+ application/json:
33987
+ schema:
33988
+ $ref: '#/components/schemas/APIErrorResponse'
33989
+ description: Not Found
33990
+ '429':
33991
+ $ref: '#/components/responses/TooManyRequestsResponse'
33992
+ security:
33993
+ - apiKeyAuth: []
33994
+ appKeyAuth: []
33995
+ - AuthZ:
33996
+ - slos_read
33997
+ summary: Get SLO report
33998
+ tags:
33999
+ - Service Level Objectives
34000
+ x-unstable: '**Note**: This feature is in private beta. To request access, use
34001
+ the request access form in the [Service Level Objectives](https://docs.datadoghq.com/service_management/service_level_objectives/#slo-csv-export)
34002
+ docs.'
34003
+ /api/v2/slo/report/{report_id}/status:
34004
+ get:
34005
+ description: Get the status of the SLO report job.
34006
+ operationId: GetSLOReportJobStatus
34007
+ parameters:
34008
+ - $ref: '#/components/parameters/ReportID'
34009
+ responses:
34010
+ '200':
34011
+ content:
34012
+ application/json:
34013
+ schema:
34014
+ $ref: '#/components/schemas/SLOReportStatusGetResponse'
34015
+ description: OK
34016
+ '400':
34017
+ content:
34018
+ application/json:
34019
+ schema:
34020
+ $ref: '#/components/schemas/APIErrorResponse'
34021
+ description: Bad Request
34022
+ '403':
34023
+ content:
34024
+ application/json:
34025
+ schema:
34026
+ $ref: '#/components/schemas/APIErrorResponse'
34027
+ description: Forbidden
34028
+ '404':
34029
+ content:
34030
+ application/json:
34031
+ schema:
34032
+ $ref: '#/components/schemas/APIErrorResponse'
34033
+ description: Not Found
34034
+ '429':
34035
+ $ref: '#/components/responses/TooManyRequestsResponse'
34036
+ security:
34037
+ - apiKeyAuth: []
34038
+ appKeyAuth: []
34039
+ - AuthZ:
34040
+ - slos_read
34041
+ summary: Get SLO report status
34042
+ tags:
34043
+ - Service Level Objectives
34044
+ x-unstable: '**Note**: This feature is in private beta. To request access, use
34045
+ the request access form in the [Service Level Objectives](https://docs.datadoghq.com/service_management/service_level_objectives/#slo-csv-export)
34046
+ docs.'
33584
34047
  /api/v2/spans/analytics/aggregate:
33585
34048
  post:
33586
34049
  description: 'The API endpoint to aggregate spans into buckets and compute metrics
@@ -34681,10 +35144,11 @@ paths:
34681
35144
  x-unstable: '**Note**: This endpoint is deprecated. See the [Teams API endpoints](https://docs.datadoghq.com/api/latest/teams/).'
34682
35145
  /api/v2/usage/application_security:
34683
35146
  get:
35147
+ deprecated: true
34684
35148
  description: 'Get hourly usage for application security .
34685
35149
 
34686
- **Note:** hourly usage data for all products is now available in the [Get
34687
- hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family)'
35150
+ **Note:** This endpoint has been deprecated. Hourly usage data for all products
35151
+ is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family)'
34688
35152
  operationId: GetUsageApplicationSecurityMonitoring
34689
35153
  parameters:
34690
35154
  - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`
@@ -35082,10 +35546,11 @@ paths:
35082
35546
  - Usage Metering
35083
35547
  /api/v2/usage/lambda_traced_invocations:
35084
35548
  get:
35549
+ deprecated: true
35085
35550
  description: 'Get hourly usage for Lambda traced invocations.
35086
35551
 
35087
- **Note:** hourly usage data for all products is now available in the [Get
35088
- hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family)'
35552
+ **Note:** This endpoint has been deprecated.. Hourly usage data for all products
35553
+ is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family)'
35089
35554
  operationId: GetUsageLambdaTracedInvocations
35090
35555
  parameters:
35091
35556
  - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`
@@ -35141,10 +35606,11 @@ paths:
35141
35606
  - Usage Metering
35142
35607
  /api/v2/usage/observability_pipelines:
35143
35608
  get:
35609
+ deprecated: true
35144
35610
  description: 'Get hourly usage for observability pipelines.
35145
35611
 
35146
- **Note:** hourly usage data for all products is now available in the [Get
35147
- hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family)'
35612
+ **Note:** This endpoint has been deprecated. Hourly usage data for all products
35613
+ is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family)'
35148
35614
  operationId: GetUsageObservabilityPipelines
35149
35615
  parameters:
35150
35616
  - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`
@@ -35868,6 +36334,10 @@ tags:
35868
36334
  - description: 'Custom Destinations forward all the logs ingested to an external destination.
35869
36335
 
35870
36336
 
36337
+ **Note**: Log forwarding is not available for the Government (US1-FED) site. Contact
36338
+ your account representative for more information.
36339
+
36340
+
35871
36341
  See the [Custom Destinations Page](https://app.datadoghq.com/logs/pipelines/log-forwarding/custom-destinations)
35872
36342
 
35873
36343
  for a list of the custom destinations currently configured in web UI.'
@@ -35988,6 +36458,18 @@ tags:
35988
36458
  externalDocs:
35989
36459
  url: https://docs.datadoghq.com/tracing/service_catalog/
35990
36460
  name: Service Definition
36461
+ - description: '[Service Level Objectives](https://docs.datadoghq.com/monitors/service_level_objectives/#configuration)
36462
+
36463
+ (SLOs) are a key part of the site reliability engineering toolkit.
36464
+
36465
+ SLOs provide a framework for defining clear targets around application performance,
36466
+
36467
+ which ultimately help teams provide a consistent customer experience,
36468
+
36469
+ balance feature development with platform stability,
36470
+
36471
+ and improve communication with internal and external users.'
36472
+ name: Service Level Objectives
35991
36473
  - description: 'API to create, update scorecard rules and outcomes. See [Service Scorecards](https://docs.datadoghq.com/service_catalog/scorecards)
35992
36474
  for more information.
35993
36475