datadog_api_client 2.23.0 → 2.24.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (94) hide show
  1. checksums.yaml +4 -4
  2. data/.apigentools-info +4 -4
  3. data/.generator/schemas/v1/openapi.yaml +666 -156
  4. data/.generator/schemas/v2/openapi.yaml +774 -89
  5. data/.generator/src/generator/replacement.json +1 -1
  6. data/.github/CODEOWNERS +5 -5
  7. data/CHANGELOG.md +26 -0
  8. data/examples/v1/dashboards/CreateDashboard_1213075383.rb +10 -4
  9. data/examples/v1/dashboards/CreateDashboard_2336428357.rb +10 -4
  10. data/examples/v1/dashboards/CreateDashboard_2563642929.rb +66 -0
  11. data/examples/v1/dashboards/CreateDashboard_3669695268.rb +10 -4
  12. data/examples/v1/dashboards/CreateDashboard_915214113.rb +10 -4
  13. data/examples/v1/monitors/UpdateMonitor.rb +1 -0
  14. data/examples/v1/synthetics/CreateSyntheticsAPITest_1241981394.rb +1 -0
  15. data/examples/v1/synthetics/CreateSyntheticsAPITest_1279271422.rb +9 -4
  16. data/examples/v1/synthetics/CreateSyntheticsAPITest_1487281163.rb +15 -0
  17. data/examples/v1/synthetics/CreateSyntheticsAPITest_1987645492.rb +134 -0
  18. data/examples/v2/api-management/ListAPIs.rb +8 -0
  19. data/examples/v2/csm-threats/CreateCSMThreatsAgentRule.rb +3 -0
  20. data/examples/v2/csm-threats/UpdateCloudWorkloadSecurityAgentRule.rb +1 -0
  21. data/examples/v2/organizations/GetOrgConfig.rb +5 -0
  22. data/examples/v2/organizations/ListOrgConfigs.rb +5 -0
  23. data/examples/v2/organizations/UpdateOrgConfig.rb +14 -0
  24. data/examples/v2/security-monitoring/TestExistingSecurityMonitoringRule.rb +21 -0
  25. data/examples/v2/security-monitoring/TestSecurityMonitoringRule.rb +58 -0
  26. data/examples/v2/security-monitoring/ValidateSecurityMonitoringRule.rb +1 -1
  27. data/lib/datadog_api_client/configuration.rb +1 -0
  28. data/lib/datadog_api_client/inflector.rb +37 -1
  29. data/lib/datadog_api_client/v1/api/monitors_api.rb +1 -1
  30. data/lib/datadog_api_client/v1/models/event.rb +1 -1
  31. data/lib/datadog_api_client/v1/models/formula_type.rb +26 -0
  32. data/lib/datadog_api_client/v1/models/geomap_widget_request.rb +14 -4
  33. data/lib/datadog_api_client/v1/models/group_type.rb +26 -0
  34. data/lib/datadog_api_client/v1/models/monitor.rb +1 -16
  35. data/lib/datadog_api_client/v1/models/monitor_update_request.rb +2 -23
  36. data/lib/datadog_api_client/v1/models/monthly_usage_attribution_values.rb +2 -2
  37. data/lib/datadog_api_client/v1/models/synthetics_api_step.rb +37 -180
  38. data/lib/datadog_api_client/v1/models/synthetics_api_test_step.rb +206 -0
  39. data/lib/datadog_api_client/v1/models/{synthetics_api_step_subtype.rb → synthetics_api_test_step_subtype.rb} +2 -2
  40. data/lib/datadog_api_client/v1/models/synthetics_api_wait_step.rb +148 -0
  41. data/lib/datadog_api_client/v1/models/synthetics_api_wait_step_subtype.rb +26 -0
  42. data/lib/datadog_api_client/v1/models/synthetics_assertion.rb +1 -0
  43. data/lib/datadog_api_client/v1/models/synthetics_assertion_body_hash_operator.rb +28 -0
  44. data/lib/datadog_api_client/v1/models/synthetics_assertion_body_hash_target.rb +140 -0
  45. data/lib/datadog_api_client/v1/models/synthetics_assertion_body_hash_type.rb +26 -0
  46. data/lib/datadog_api_client/v1/models/synthetics_assertion_json_path_target_target.rb +11 -1
  47. data/lib/datadog_api_client/v1/models/synthetics_test_options_monitor_options.rb +0 -4
  48. data/lib/datadog_api_client/v1/models/synthetics_test_request_body_file.rb +22 -1
  49. data/lib/datadog_api_client/v1/models/table_widget_request.rb +14 -4
  50. data/lib/datadog_api_client/v1/models/toplist_widget_request.rb +11 -1
  51. data/lib/datadog_api_client/v1/models/usage_rum_sessions_hour.rb +7 -7
  52. data/lib/datadog_api_client/v1/models/usage_rum_sessions_response.rb +2 -2
  53. data/lib/datadog_api_client/v1/models/usage_summary_date.rb +168 -18
  54. data/lib/datadog_api_client/v1/models/usage_summary_date_org.rb +169 -19
  55. data/lib/datadog_api_client/v1/models/usage_summary_response.rb +171 -21
  56. data/lib/datadog_api_client/v1/models/widget_formula_sort.rb +144 -0
  57. data/lib/datadog_api_client/v1/models/widget_group_sort.rb +140 -0
  58. data/lib/datadog_api_client/v1/models/widget_sort_by.rb +110 -0
  59. data/lib/datadog_api_client/v1/models/widget_sort_order_by.rb +63 -0
  60. data/lib/datadog_api_client/v2/api/api_management_api.rb +80 -2
  61. data/lib/datadog_api_client/v2/api/organizations_api.rb +197 -0
  62. data/lib/datadog_api_client/v2/api/security_monitoring_api.rb +140 -1
  63. data/lib/datadog_api_client/v2/models/cloud_configuration_rule_payload.rb +240 -0
  64. data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_rule_create_attributes.rb +13 -1
  65. data/lib/datadog_api_client/v2/models/dora_incident_request_attributes.rb +1 -1
  66. data/lib/datadog_api_client/v2/models/events_group_by.rb +5 -4
  67. data/lib/datadog_api_client/v2/models/list_apis_response.rb +92 -0
  68. data/lib/datadog_api_client/v2/models/list_apis_response_data.rb +90 -0
  69. data/lib/datadog_api_client/v2/models/list_apis_response_data_attributes.rb +80 -0
  70. data/lib/datadog_api_client/v2/models/list_apis_response_meta.rb +80 -0
  71. data/lib/datadog_api_client/v2/models/list_apis_response_meta_pagination.rb +100 -0
  72. data/lib/datadog_api_client/v2/models/org_config_get_response.rb +98 -0
  73. data/lib/datadog_api_client/v2/models/org_config_list_response.rb +100 -0
  74. data/lib/datadog_api_client/v2/models/org_config_read.rb +140 -0
  75. data/lib/datadog_api_client/v2/models/org_config_read_attributes.rb +179 -0
  76. data/lib/datadog_api_client/v2/models/org_config_type.rb +26 -0
  77. data/lib/datadog_api_client/v2/models/org_config_write.rb +119 -0
  78. data/lib/datadog_api_client/v2/models/org_config_write_attributes.rb +98 -0
  79. data/lib/datadog_api_client/v2/models/org_config_write_request.rb +98 -0
  80. data/lib/datadog_api_client/v2/models/security_monitoring_rule_query_payload.rb +118 -0
  81. data/lib/datadog_api_client/v2/models/security_monitoring_rule_query_payload_data.rb +120 -0
  82. data/lib/datadog_api_client/v2/models/security_monitoring_rule_test_payload.rb +62 -0
  83. data/lib/datadog_api_client/v2/models/security_monitoring_rule_test_request.rb +92 -0
  84. data/lib/datadog_api_client/v2/models/security_monitoring_rule_test_response.rb +84 -0
  85. data/lib/datadog_api_client/v2/models/security_monitoring_rule_type_test.rb +26 -0
  86. data/lib/datadog_api_client/v2/models/security_monitoring_rule_update_payload.rb +1 -1
  87. data/lib/datadog_api_client/v2/models/security_monitoring_rule_validate_payload.rb +64 -0
  88. data/lib/datadog_api_client/v2/models/security_monitoring_signal_rule_payload.rb +251 -0
  89. data/lib/datadog_api_client/v2/models/security_monitoring_standard_rule_create_payload.rb +1 -1
  90. data/lib/datadog_api_client/v2/models/security_monitoring_standard_rule_payload.rb +263 -0
  91. data/lib/datadog_api_client/v2/models/security_monitoring_standard_rule_response.rb +1 -1
  92. data/lib/datadog_api_client/v2/models/security_monitoring_standard_rule_test_payload.rb +263 -0
  93. data/lib/datadog_api_client/version.rb +1 -1
  94. metadata +47 -3
@@ -373,6 +373,14 @@ components:
373
373
  required: true
374
374
  schema:
375
375
  type: string
376
+ OrgConfigName:
377
+ description: The name of an Org Config.
378
+ in: path
379
+ name: org_config_name
380
+ required: true
381
+ schema:
382
+ example: monitor_timezone
383
+ type: string
376
384
  PageNumber:
377
385
  description: Specific page number to return.
378
386
  in: query
@@ -3961,6 +3969,68 @@ components:
3961
3969
  required:
3962
3970
  - complianceRuleOptions
3963
3971
  type: object
3972
+ CloudConfigurationRulePayload:
3973
+ description: The payload of a cloud configuration rule.
3974
+ properties:
3975
+ cases:
3976
+ description: 'Description of generated findings and signals (severity and
3977
+ channels to be notified in case of a signal). Must contain exactly one
3978
+ item.
3979
+
3980
+ '
3981
+ items:
3982
+ $ref: '#/components/schemas/CloudConfigurationRuleCaseCreate'
3983
+ type: array
3984
+ complianceSignalOptions:
3985
+ $ref: '#/components/schemas/CloudConfigurationRuleComplianceSignalOptions'
3986
+ filters:
3987
+ description: Additional queries to filter matched events before they are
3988
+ processed.
3989
+ items:
3990
+ $ref: '#/components/schemas/SecurityMonitoringFilter'
3991
+ type: array
3992
+ isEnabled:
3993
+ description: Whether the rule is enabled.
3994
+ example: true
3995
+ type: boolean
3996
+ message:
3997
+ description: Message in markdown format for generated findings and signals.
3998
+ example: '#Description
3999
+
4000
+ Explanation of the rule.
4001
+
4002
+
4003
+ #Remediation
4004
+
4005
+ How to fix the security issue.
4006
+
4007
+ '
4008
+ type: string
4009
+ name:
4010
+ description: The name of the rule.
4011
+ example: My security monitoring rule.
4012
+ type: string
4013
+ options:
4014
+ $ref: '#/components/schemas/CloudConfigurationRuleOptions'
4015
+ tags:
4016
+ description: Tags for generated findings and signals.
4017
+ example:
4018
+ - env:prod
4019
+ - team:security
4020
+ items:
4021
+ description: Tag.
4022
+ type: string
4023
+ type: array
4024
+ type:
4025
+ $ref: '#/components/schemas/CloudConfigurationRuleType'
4026
+ required:
4027
+ - name
4028
+ - isEnabled
4029
+ - options
4030
+ - complianceSignalOptions
4031
+ - cases
4032
+ - message
4033
+ type: object
3964
4034
  CloudConfigurationRuleType:
3965
4035
  description: The rule type.
3966
4036
  enum:
@@ -4105,6 +4175,11 @@ components:
4105
4175
  description: The SECL expression of the Agent rule.
4106
4176
  example: exec.file.name == \"sh\"
4107
4177
  type: string
4178
+ filters:
4179
+ description: The platforms the Agent rule is supported on.
4180
+ items:
4181
+ type: string
4182
+ type: array
4108
4183
  name:
4109
4184
  description: The name of the Agent rule.
4110
4185
  example: my_agent_rule
@@ -6150,7 +6225,7 @@ components:
6150
6225
  type: string
6151
6226
  finished_at:
6152
6227
  description: Unix timestamp in nanoseconds when the incident finished. It
6153
- should not be older than 3 hours.
6228
+ should not be older than 1 hour.
6154
6229
  example: 1693491984000000000
6155
6230
  format: int64
6156
6231
  type: integer
@@ -7327,10 +7402,15 @@ components:
7327
7402
  example: '@error.type'
7328
7403
  type: string
7329
7404
  limit:
7330
- description: The maximum number of groups to return.
7405
+ default: 10
7406
+ description: 'The maximum buckets to return for this group by. Note: at
7407
+ most 10000 buckets are allowed.
7408
+
7409
+ If grouping by multiple facets, the product of limits must not exceed
7410
+ 10000.'
7331
7411
  example: 10
7332
7412
  format: int32
7333
- maximum: 2147483647
7413
+ maximum: 10000
7334
7414
  type: integer
7335
7415
  sort:
7336
7416
  $ref: '#/components/schemas/EventsGroupBySort'
@@ -10487,6 +10567,58 @@ components:
10487
10567
  description: Jira project key
10488
10568
  type: string
10489
10569
  type: object
10570
+ ListAPIsResponse:
10571
+ description: Response for `ListAPIs`.
10572
+ properties:
10573
+ data:
10574
+ description: List of API items.
10575
+ items:
10576
+ $ref: '#/components/schemas/ListAPIsResponseData'
10577
+ type: array
10578
+ meta:
10579
+ $ref: '#/components/schemas/ListAPIsResponseMeta'
10580
+ type: object
10581
+ ListAPIsResponseData:
10582
+ description: Data envelope for `ListAPIsResponse`.
10583
+ properties:
10584
+ attributes:
10585
+ $ref: '#/components/schemas/ListAPIsResponseDataAttributes'
10586
+ id:
10587
+ $ref: '#/components/schemas/ApiID'
10588
+ type: object
10589
+ ListAPIsResponseDataAttributes:
10590
+ description: Attributes for `ListAPIsResponseData`.
10591
+ properties:
10592
+ name:
10593
+ description: API name.
10594
+ example: Payments API
10595
+ type: string
10596
+ type: object
10597
+ ListAPIsResponseMeta:
10598
+ description: Metadata for `ListAPIsResponse`.
10599
+ properties:
10600
+ pagination:
10601
+ $ref: '#/components/schemas/ListAPIsResponseMetaPagination'
10602
+ type: object
10603
+ ListAPIsResponseMetaPagination:
10604
+ description: Pagination metadata information for `ListAPIsResponse`.
10605
+ properties:
10606
+ limit:
10607
+ description: Number of items in the current page.
10608
+ example: 20
10609
+ format: int64
10610
+ type: integer
10611
+ offset:
10612
+ description: Offset for pagination.
10613
+ example: 0
10614
+ format: int64
10615
+ type: integer
10616
+ total_count:
10617
+ description: Total number of items.
10618
+ example: 35
10619
+ format: int64
10620
+ type: integer
10621
+ type: object
10490
10622
  ListApplicationKeysResponse:
10491
10623
  description: Response for a list of application keys.
10492
10624
  properties:
@@ -13703,6 +13835,104 @@ components:
13703
13835
  required:
13704
13836
  - data
13705
13837
  type: object
13838
+ OrgConfigGetResponse:
13839
+ description: A response with a single Org Config.
13840
+ properties:
13841
+ data:
13842
+ $ref: '#/components/schemas/OrgConfigRead'
13843
+ required:
13844
+ - data
13845
+ type: object
13846
+ OrgConfigListResponse:
13847
+ description: A response with multiple Org Configs.
13848
+ properties:
13849
+ data:
13850
+ description: An array of Org Configs.
13851
+ items:
13852
+ $ref: '#/components/schemas/OrgConfigRead'
13853
+ type: array
13854
+ required:
13855
+ - data
13856
+ type: object
13857
+ OrgConfigRead:
13858
+ description: A single Org Config.
13859
+ properties:
13860
+ attributes:
13861
+ $ref: '#/components/schemas/OrgConfigReadAttributes'
13862
+ id:
13863
+ description: A unique identifier for an Org Config.
13864
+ example: abcd1234
13865
+ type: string
13866
+ type:
13867
+ $ref: '#/components/schemas/OrgConfigType'
13868
+ required:
13869
+ - id
13870
+ - type
13871
+ - attributes
13872
+ type: object
13873
+ OrgConfigReadAttributes:
13874
+ description: Readable attributes of an Org Config.
13875
+ properties:
13876
+ description:
13877
+ description: The description of an Org Config.
13878
+ example: Frobulate the turbo encabulator manifold
13879
+ type: string
13880
+ modified_at:
13881
+ description: The timestamp of the last Org Config update (if any).
13882
+ format: date-time
13883
+ nullable: true
13884
+ type: string
13885
+ name:
13886
+ description: The machine-friendly name of an Org Config.
13887
+ example: monitor_timezone
13888
+ type: string
13889
+ value:
13890
+ description: The value of an Org Config.
13891
+ value_type:
13892
+ description: The type of an Org Config value.
13893
+ example: bool
13894
+ type: string
13895
+ required:
13896
+ - name
13897
+ - description
13898
+ - value_type
13899
+ - value
13900
+ type: object
13901
+ OrgConfigType:
13902
+ description: Data type of an Org Config.
13903
+ enum:
13904
+ - org_configs
13905
+ example: org_configs
13906
+ type: string
13907
+ x-enum-varnames:
13908
+ - ORG_CONFIGS
13909
+ OrgConfigWrite:
13910
+ description: An Org Config write operation.
13911
+ properties:
13912
+ attributes:
13913
+ $ref: '#/components/schemas/OrgConfigWriteAttributes'
13914
+ type:
13915
+ $ref: '#/components/schemas/OrgConfigType'
13916
+ required:
13917
+ - type
13918
+ - attributes
13919
+ type: object
13920
+ OrgConfigWriteAttributes:
13921
+ description: Writable attributes of an Org Config.
13922
+ properties:
13923
+ value:
13924
+ description: The value of an Org Config.
13925
+ required:
13926
+ - value
13927
+ type: object
13928
+ OrgConfigWriteRequest:
13929
+ description: A request to update an Org Config.
13930
+ properties:
13931
+ data:
13932
+ $ref: '#/components/schemas/OrgConfigWrite'
13933
+ required:
13934
+ - data
13935
+ type: object
13706
13936
  Organization:
13707
13937
  description: Organization object.
13708
13938
  properties:
@@ -17402,6 +17632,47 @@ components:
17402
17632
  - GEO_DATA
17403
17633
  - EVENT_COUNT
17404
17634
  - NONE
17635
+ SecurityMonitoringRuleQueryPayload:
17636
+ description: Payload to test a rule query with the expected result.
17637
+ properties:
17638
+ expectedResult:
17639
+ description: Expected result of the test.
17640
+ example: true
17641
+ type: boolean
17642
+ index:
17643
+ description: Index of the query under test.
17644
+ example: 0
17645
+ format: int64
17646
+ minimum: 0
17647
+ type: integer
17648
+ payload:
17649
+ $ref: '#/components/schemas/SecurityMonitoringRuleQueryPayloadData'
17650
+ type: object
17651
+ SecurityMonitoringRuleQueryPayloadData:
17652
+ additionalProperties: {}
17653
+ description: Payload used to test the rule query.
17654
+ properties:
17655
+ ddsource:
17656
+ description: Source of the payload.
17657
+ example: nginx
17658
+ type: string
17659
+ ddtags:
17660
+ description: Tags associated with your data.
17661
+ example: env:staging,version:5.1
17662
+ type: string
17663
+ hostname:
17664
+ description: The name of the originating host of the log.
17665
+ example: i-012345678
17666
+ type: string
17667
+ message:
17668
+ description: The message of the payload.
17669
+ example: 2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World
17670
+ type: string
17671
+ service:
17672
+ description: The name of the application or service generating the data.
17673
+ example: payment
17674
+ type: string
17675
+ type: object
17405
17676
  SecurityMonitoringRuleResponse:
17406
17677
  description: Create a new rule.
17407
17678
  oneOf:
@@ -17423,6 +17694,36 @@ components:
17423
17694
  - MEDIUM
17424
17695
  - HIGH
17425
17696
  - CRITICAL
17697
+ SecurityMonitoringRuleTestPayload:
17698
+ description: Test a rule.
17699
+ oneOf:
17700
+ - $ref: '#/components/schemas/SecurityMonitoringStandardRuleTestPayload'
17701
+ SecurityMonitoringRuleTestRequest:
17702
+ description: Test the rule queries of a rule (rule property is ignored when
17703
+ applied to an existing rule)
17704
+ properties:
17705
+ rule:
17706
+ $ref: '#/components/schemas/SecurityMonitoringRuleTestPayload'
17707
+ ruleQueryPayloads:
17708
+ description: Data payloads used to test rules query with the expected result.
17709
+ items:
17710
+ $ref: '#/components/schemas/SecurityMonitoringRuleQueryPayload'
17711
+ type: array
17712
+ type: object
17713
+ SecurityMonitoringRuleTestResponse:
17714
+ description: Result of the test of the rule queries.
17715
+ properties:
17716
+ results:
17717
+ description: 'Assert results are returned in the same order as the rule
17718
+ query payloads.
17719
+
17720
+ For each payload, it returns True if the result matched the expected result,
17721
+
17722
+ False otherwise.'
17723
+ items:
17724
+ type: boolean
17725
+ type: array
17726
+ type: object
17426
17727
  SecurityMonitoringRuleThirdPartyOptions:
17427
17728
  description: Options on third party rules.
17428
17729
  properties:
@@ -17473,6 +17774,13 @@ components:
17473
17774
  - WORKLOAD_SECURITY
17474
17775
  - CLOUD_CONFIGURATION
17475
17776
  - APPLICATION_SECURITY
17777
+ SecurityMonitoringRuleTypeTest:
17778
+ description: The rule type.
17779
+ enum:
17780
+ - log_detection
17781
+ type: string
17782
+ x-enum-varnames:
17783
+ - LOG_DETECTION
17476
17784
  SecurityMonitoringRuleUpdatePayload:
17477
17785
  description: Update an existing rule.
17478
17786
  properties:
@@ -17518,8 +17826,8 @@ components:
17518
17826
  type: string
17519
17827
  type: array
17520
17828
  thirdPartyCases:
17521
- description: Cases for generating signals from third party rules. Only available
17522
- for third party rules.
17829
+ description: Cases for generating signals from third-party rules. Only available
17830
+ for third-party rules.
17523
17831
  example: []
17524
17832
  items:
17525
17833
  $ref: '#/components/schemas/SecurityMonitoringThirdPartyRuleCase'
@@ -17531,6 +17839,12 @@ components:
17531
17839
  maximum: 2147483647
17532
17840
  type: integer
17533
17841
  type: object
17842
+ SecurityMonitoringRuleValidatePayload:
17843
+ description: Validate a rule.
17844
+ oneOf:
17845
+ - $ref: '#/components/schemas/SecurityMonitoringStandardRulePayload'
17846
+ - $ref: '#/components/schemas/SecurityMonitoringSignalRulePayload'
17847
+ - $ref: '#/components/schemas/CloudConfigurationRulePayload'
17534
17848
  SecurityMonitoringSignal:
17535
17849
  description: Object description of a security signal.
17536
17850
  properties:
@@ -17783,34 +18097,94 @@ components:
17783
18097
  - cases
17784
18098
  - message
17785
18099
  type: object
17786
- SecurityMonitoringSignalRuleQuery:
17787
- description: Query for matching rule on signals.
18100
+ SecurityMonitoringSignalRulePayload:
18101
+ description: The payload of a signal correlation rule.
17788
18102
  properties:
17789
- aggregation:
17790
- $ref: '#/components/schemas/SecurityMonitoringRuleQueryAggregation'
17791
- correlatedByFields:
17792
- description: Fields to group by.
18103
+ cases:
18104
+ description: Cases for generating signals.
18105
+ example: []
17793
18106
  items:
17794
- description: Field.
17795
- type: string
18107
+ $ref: '#/components/schemas/SecurityMonitoringRuleCaseCreate'
17796
18108
  type: array
17797
- correlatedQueryIndex:
17798
- description: Index of the rule query used to retrieve the correlated field.
17799
- format: int32
17800
- maximum: 9
17801
- type: integer
17802
- metrics:
17803
- description: Group of target fields to aggregate over.
18109
+ filters:
18110
+ description: Additional queries to filter matched events before they are
18111
+ processed. This field is deprecated for log detection, signal correlation,
18112
+ and workload security rules.
17804
18113
  items:
17805
- description: Field.
17806
- type: string
18114
+ $ref: '#/components/schemas/SecurityMonitoringFilter'
17807
18115
  type: array
18116
+ hasExtendedTitle:
18117
+ description: Whether the notifications include the triggering group-by values
18118
+ in their title.
18119
+ example: true
18120
+ type: boolean
18121
+ isEnabled:
18122
+ description: Whether the rule is enabled.
18123
+ example: true
18124
+ type: boolean
18125
+ message:
18126
+ description: Message for generated signals.
18127
+ example: ''
18128
+ type: string
17808
18129
  name:
17809
- description: Name of the query.
18130
+ description: The name of the rule.
18131
+ example: My security monitoring rule.
17810
18132
  type: string
17811
- ruleId:
17812
- description: Rule ID to match on signals.
17813
- example: org-ru1-e1d
18133
+ options:
18134
+ $ref: '#/components/schemas/SecurityMonitoringRuleOptions'
18135
+ queries:
18136
+ description: Queries for selecting signals which are part of the rule.
18137
+ example: []
18138
+ items:
18139
+ $ref: '#/components/schemas/SecurityMonitoringSignalRuleQuery'
18140
+ type: array
18141
+ tags:
18142
+ description: Tags for generated signals.
18143
+ example:
18144
+ - env:prod
18145
+ - team:security
18146
+ items:
18147
+ description: Tag.
18148
+ type: string
18149
+ type: array
18150
+ type:
18151
+ $ref: '#/components/schemas/SecurityMonitoringSignalRuleType'
18152
+ required:
18153
+ - name
18154
+ - isEnabled
18155
+ - queries
18156
+ - options
18157
+ - cases
18158
+ - message
18159
+ type: object
18160
+ SecurityMonitoringSignalRuleQuery:
18161
+ description: Query for matching rule on signals.
18162
+ properties:
18163
+ aggregation:
18164
+ $ref: '#/components/schemas/SecurityMonitoringRuleQueryAggregation'
18165
+ correlatedByFields:
18166
+ description: Fields to group by.
18167
+ items:
18168
+ description: Field.
18169
+ type: string
18170
+ type: array
18171
+ correlatedQueryIndex:
18172
+ description: Index of the rule query used to retrieve the correlated field.
18173
+ format: int32
18174
+ maximum: 9
18175
+ type: integer
18176
+ metrics:
18177
+ description: Group of target fields to aggregate over.
18178
+ items:
18179
+ description: Field.
18180
+ type: string
18181
+ type: array
18182
+ name:
18183
+ description: Name of the query.
18184
+ type: string
18185
+ ruleId:
18186
+ description: Rule ID to match on signals.
18187
+ example: org-ru1-e1d
17814
18188
  type: string
17815
18189
  required:
17816
18190
  - ruleId
@@ -18157,8 +18531,75 @@ components:
18157
18531
  type: string
18158
18532
  type: array
18159
18533
  thirdPartyCases:
18160
- description: Cases for generating signals from third party rules. Only available
18161
- for third party rules.
18534
+ description: Cases for generating signals from third-party rules. Only available
18535
+ for third-party rules.
18536
+ example: []
18537
+ items:
18538
+ $ref: '#/components/schemas/SecurityMonitoringThirdPartyRuleCaseCreate'
18539
+ type: array
18540
+ type:
18541
+ $ref: '#/components/schemas/SecurityMonitoringRuleTypeCreate'
18542
+ required:
18543
+ - name
18544
+ - isEnabled
18545
+ - queries
18546
+ - options
18547
+ - cases
18548
+ - message
18549
+ type: object
18550
+ SecurityMonitoringStandardRulePayload:
18551
+ description: The payload of a rule.
18552
+ properties:
18553
+ cases:
18554
+ description: Cases for generating signals.
18555
+ example: []
18556
+ items:
18557
+ $ref: '#/components/schemas/SecurityMonitoringRuleCaseCreate'
18558
+ type: array
18559
+ filters:
18560
+ description: Additional queries to filter matched events before they are
18561
+ processed. This field is deprecated for log detection, signal correlation,
18562
+ and workload security rules.
18563
+ items:
18564
+ $ref: '#/components/schemas/SecurityMonitoringFilter'
18565
+ type: array
18566
+ hasExtendedTitle:
18567
+ description: Whether the notifications include the triggering group-by values
18568
+ in their title.
18569
+ example: true
18570
+ type: boolean
18571
+ isEnabled:
18572
+ description: Whether the rule is enabled.
18573
+ example: true
18574
+ type: boolean
18575
+ message:
18576
+ description: Message for generated signals.
18577
+ example: ''
18578
+ type: string
18579
+ name:
18580
+ description: The name of the rule.
18581
+ example: My security monitoring rule.
18582
+ type: string
18583
+ options:
18584
+ $ref: '#/components/schemas/SecurityMonitoringRuleOptions'
18585
+ queries:
18586
+ description: Queries for selecting logs which are part of the rule.
18587
+ example: []
18588
+ items:
18589
+ $ref: '#/components/schemas/SecurityMonitoringStandardRuleQuery'
18590
+ type: array
18591
+ tags:
18592
+ description: Tags for generated signals.
18593
+ example:
18594
+ - env:prod
18595
+ - team:security
18596
+ items:
18597
+ description: Tag.
18598
+ type: string
18599
+ type: array
18600
+ thirdPartyCases:
18601
+ description: Cases for generating signals from third-party rules. Only available
18602
+ for third-party rules.
18162
18603
  example: []
18163
18604
  items:
18164
18605
  $ref: '#/components/schemas/SecurityMonitoringThirdPartyRuleCaseCreate'
@@ -18294,8 +18735,8 @@ components:
18294
18735
  type: string
18295
18736
  type: array
18296
18737
  thirdPartyCases:
18297
- description: Cases for generating signals from third party rules. Only available
18298
- for third party rules.
18738
+ description: Cases for generating signals from third-party rules. Only available
18739
+ for third-party rules.
18299
18740
  example: []
18300
18741
  items:
18301
18742
  $ref: '#/components/schemas/SecurityMonitoringThirdPartyRuleCase'
@@ -18310,6 +18751,73 @@ components:
18310
18751
  description: The version of the rule.
18311
18752
  format: int64
18312
18753
  type: integer
18754
+ SecurityMonitoringStandardRuleTestPayload:
18755
+ description: The payload of a rule to test
18756
+ properties:
18757
+ cases:
18758
+ description: Cases for generating signals.
18759
+ example: []
18760
+ items:
18761
+ $ref: '#/components/schemas/SecurityMonitoringRuleCaseCreate'
18762
+ type: array
18763
+ filters:
18764
+ description: Additional queries to filter matched events before they are
18765
+ processed. This field is deprecated for log detection, signal correlation,
18766
+ and workload security rules.
18767
+ items:
18768
+ $ref: '#/components/schemas/SecurityMonitoringFilter'
18769
+ type: array
18770
+ hasExtendedTitle:
18771
+ description: Whether the notifications include the triggering group-by values
18772
+ in their title.
18773
+ example: true
18774
+ type: boolean
18775
+ isEnabled:
18776
+ description: Whether the rule is enabled.
18777
+ example: true
18778
+ type: boolean
18779
+ message:
18780
+ description: Message for generated signals.
18781
+ example: ''
18782
+ type: string
18783
+ name:
18784
+ description: The name of the rule.
18785
+ example: My security monitoring rule.
18786
+ type: string
18787
+ options:
18788
+ $ref: '#/components/schemas/SecurityMonitoringRuleOptions'
18789
+ queries:
18790
+ description: Queries for selecting logs which are part of the rule.
18791
+ example: []
18792
+ items:
18793
+ $ref: '#/components/schemas/SecurityMonitoringStandardRuleQuery'
18794
+ type: array
18795
+ tags:
18796
+ description: Tags for generated signals.
18797
+ example:
18798
+ - env:prod
18799
+ - team:security
18800
+ items:
18801
+ description: Tag.
18802
+ type: string
18803
+ type: array
18804
+ thirdPartyCases:
18805
+ description: Cases for generating signals from third-party rules. Only available
18806
+ for third-party rules.
18807
+ example: []
18808
+ items:
18809
+ $ref: '#/components/schemas/SecurityMonitoringThirdPartyRuleCaseCreate'
18810
+ type: array
18811
+ type:
18812
+ $ref: '#/components/schemas/SecurityMonitoringRuleTypeTest'
18813
+ required:
18814
+ - name
18815
+ - isEnabled
18816
+ - queries
18817
+ - options
18818
+ - cases
18819
+ - message
18820
+ type: object
18313
18821
  SecurityMonitoringSuppression:
18314
18822
  description: The suppression rule's properties.
18315
18823
  properties:
@@ -22732,10 +23240,14 @@ components:
22732
23240
  authorizationCode:
22733
23241
  authorizationUrl: /oauth2/v1/authorize
22734
23242
  scopes:
23243
+ apm_api_catalog_read: View API catalog and API definitions.
23244
+ apm_api_catalog_write: Add, modify, and delete API catalog definitions.
22735
23245
  apm_read: Read and query APM and Trace Analytics.
22736
23246
  apm_service_catalog_read: View service catalog and service definitions.
22737
23247
  apm_service_catalog_write: Add, modify, and delete service catalog definitions
22738
23248
  when those definitions are maintained by Datadog.
23249
+ cases_read: View Cases.
23250
+ cases_write: Create and update cases.
22739
23251
  ci_visibility_pipelines_write: Create CI Visibility pipeline spans using
22740
23252
  the API.
22741
23253
  ci_visibility_read: View CI Visibility.
@@ -22804,6 +23316,9 @@ components:
22804
23316
  user_access_manage: Disable users, manage user roles, manage SAML-to-role
22805
23317
  mappings, and configure logs restriction queries.
22806
23318
  user_access_read: View users and their roles and settings.
23319
+ workflows_read: View workflows.
23320
+ workflows_run: Run workflows.
23321
+ workflows_write: Create, edit, and delete workflows.
22807
23322
  tokenUrl: /oauth2/v1/token
22808
23323
  type: oauth2
22809
23324
  apiKeyAuth:
@@ -23000,6 +23515,63 @@ paths:
23000
23515
  tags:
23001
23516
  - Key Management
23002
23517
  x-codegen-request-body-name: body
23518
+ /api/v2/apicatalog/api:
23519
+ get:
23520
+ description: List APIs and their IDs.
23521
+ operationId: ListAPIs
23522
+ parameters:
23523
+ - description: Filter APIs by name
23524
+ in: query
23525
+ name: query
23526
+ required: false
23527
+ schema:
23528
+ example: payments
23529
+ type: string
23530
+ - description: Number of items per page.
23531
+ in: query
23532
+ name: page[limit]
23533
+ required: false
23534
+ schema:
23535
+ default: 20
23536
+ format: int64
23537
+ minimum: 1
23538
+ type: integer
23539
+ - description: Offset for pagination.
23540
+ in: query
23541
+ name: page[offset]
23542
+ required: false
23543
+ schema:
23544
+ default: 0
23545
+ format: int64
23546
+ minimum: 0
23547
+ type: integer
23548
+ responses:
23549
+ '200':
23550
+ content:
23551
+ application/json:
23552
+ schema:
23553
+ $ref: '#/components/schemas/ListAPIsResponse'
23554
+ description: OK
23555
+ '400':
23556
+ content:
23557
+ application/json:
23558
+ schema:
23559
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
23560
+ description: Bad request
23561
+ '403':
23562
+ content:
23563
+ application/json:
23564
+ schema:
23565
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
23566
+ description: Forbidden
23567
+ '429':
23568
+ $ref: '#/components/responses/TooManyRequestsResponse'
23569
+ summary: List APIs
23570
+ tags:
23571
+ - API Management
23572
+ x-unstable: '**Note**: This endpoint is in public beta.
23573
+
23574
+ If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
23003
23575
  /api/v2/apicatalog/api/{id}:
23004
23576
  delete:
23005
23577
  description: Delete a specific API by ID.
@@ -23146,11 +23718,10 @@ paths:
23146
23718
  description: 'Create a new API from the [OpenAPI](https://spec.openapis.org/oas/latest.html)
23147
23719
  specification given.
23148
23720
 
23149
- It supports version `2.0`, `3.0` and `3.1` of the specification. A specific
23150
- extension section, `x-datadog`,
23721
+ See the [API Catalog documentation](https://docs.datadoghq.com/api_catalog/add_metadata/)
23722
+ for additional
23151
23723
 
23152
- let you specify the `teamHandle` for your team responsible for the API in
23153
- Datadog.
23724
+ information about the possible metadata.
23154
23725
 
23155
23726
  It returns the created API ID.
23156
23727
 
@@ -23773,7 +24344,6 @@ paths:
23773
24344
  summary: List all AuthN Mappings
23774
24345
  tags:
23775
24346
  - AuthN Mappings
23776
- x-permission: OPEN()
23777
24347
  post:
23778
24348
  description: Create an AuthN Mapping.
23779
24349
  operationId: CreateAuthNMapping
@@ -23814,7 +24384,6 @@ paths:
23814
24384
  tags:
23815
24385
  - AuthN Mappings
23816
24386
  x-codegen-request-body-name: body
23817
- x-permission: OR(USER_ACCESS_MANAGE)
23818
24387
  /api/v2/authn_mappings/{authn_mapping_id}:
23819
24388
  delete:
23820
24389
  description: Delete an AuthN Mapping specified by AuthN Mapping UUID.
@@ -23846,7 +24415,6 @@ paths:
23846
24415
  summary: Delete an AuthN Mapping
23847
24416
  tags:
23848
24417
  - AuthN Mappings
23849
- x-permission: OR(USER_ACCESS_MANAGE)
23850
24418
  get:
23851
24419
  description: Get an AuthN Mapping specified by the AuthN Mapping UUID.
23852
24420
  operationId: GetAuthNMapping
@@ -23880,7 +24448,6 @@ paths:
23880
24448
  summary: Get an AuthN Mapping by UUID
23881
24449
  tags:
23882
24450
  - AuthN Mappings
23883
- x-permission: OPEN()
23884
24451
  patch:
23885
24452
  description: Edit an AuthN Mapping.
23886
24453
  operationId: UpdateAuthNMapping
@@ -23940,7 +24507,6 @@ paths:
23940
24507
  tags:
23941
24508
  - AuthN Mappings
23942
24509
  x-codegen-request-body-name: body
23943
- x-permission: OR(USER_ACCESS_MANAGE)
23944
24510
  /api/v2/cases:
23945
24511
  get:
23946
24512
  description: Search cases.
@@ -24920,10 +25486,6 @@ paths:
24920
25486
  summary: List Cloud Cost Management AWS CUR configs
24921
25487
  tags:
24922
25488
  - Cloud Cost Management
24923
- x-permission:
24924
- operator: OR
24925
- permissions:
24926
- - CLOUD_COST_MANAGEMENT_READ
24927
25489
  post:
24928
25490
  description: Create a Cloud Cost Management account for an AWS CUR config.
24929
25491
  operationId: CreateCostAWSCURConfig
@@ -24962,10 +25524,6 @@ paths:
24962
25524
  summary: Create Cloud Cost Management AWS CUR config
24963
25525
  tags:
24964
25526
  - Cloud Cost Management
24965
- x-permission:
24966
- operator: OR
24967
- permissions:
24968
- - CLOUD_COST_MANAGEMENT_WRITE
24969
25527
  /api/v2/cost/aws_cur_config/{cloud_account_id}:
24970
25528
  delete:
24971
25529
  description: Archive a Cloud Cost Management Account.
@@ -24997,10 +25555,6 @@ paths:
24997
25555
  summary: Delete Cloud Cost Management AWS CUR config
24998
25556
  tags:
24999
25557
  - Cloud Cost Management
25000
- x-permission:
25001
- operator: OR
25002
- permissions:
25003
- - CLOUD_COST_MANAGEMENT_WRITE
25004
25558
  patch:
25005
25559
  description: Update the status of an AWS CUR config (active/archived).
25006
25560
  operationId: UpdateCostAWSCURConfig
@@ -25035,10 +25589,6 @@ paths:
25035
25589
  summary: Update Cloud Cost Management AWS CUR config
25036
25590
  tags:
25037
25591
  - Cloud Cost Management
25038
- x-permission:
25039
- operator: OR
25040
- permissions:
25041
- - CLOUD_COST_MANAGEMENT_WRITE
25042
25592
  /api/v2/cost/aws_related_accounts:
25043
25593
  get:
25044
25594
  description: List the AWS accounts in an organization by calling 'organizations:ListAccounts'
@@ -25081,10 +25631,6 @@ paths:
25081
25631
  summary: List related AWS accounts
25082
25632
  tags:
25083
25633
  - Cloud Cost Management
25084
- x-permission:
25085
- operator: OR
25086
- permissions:
25087
- - CLOUD_COST_MANAGEMENT_READ
25088
25634
  /api/v2/cost/azure_uc_config:
25089
25635
  get:
25090
25636
  description: List the Azure configs.
@@ -25112,10 +25658,6 @@ paths:
25112
25658
  summary: List Cloud Cost Management Azure configs
25113
25659
  tags:
25114
25660
  - Cloud Cost Management
25115
- x-permission:
25116
- operator: OR
25117
- permissions:
25118
- - CLOUD_COST_MANAGEMENT_READ
25119
25661
  post:
25120
25662
  description: Create a Cloud Cost Management account for an Azure config.
25121
25663
  operationId: CreateCostAzureUCConfigs
@@ -25154,10 +25696,6 @@ paths:
25154
25696
  summary: Create Cloud Cost Management Azure configs
25155
25697
  tags:
25156
25698
  - Cloud Cost Management
25157
- x-permission:
25158
- operator: OR
25159
- permissions:
25160
- - CLOUD_COST_MANAGEMENT_WRITE
25161
25699
  /api/v2/cost/azure_uc_config/{cloud_account_id}:
25162
25700
  delete:
25163
25701
  description: Archive a Cloud Cost Management Account.
@@ -25189,10 +25727,6 @@ paths:
25189
25727
  summary: Delete Cloud Cost Management Azure config
25190
25728
  tags:
25191
25729
  - Cloud Cost Management
25192
- x-permission:
25193
- operator: OR
25194
- permissions:
25195
- - CLOUD_COST_MANAGEMENT_WRITE
25196
25730
  patch:
25197
25731
  description: Update the status of an Azure config (active/archived).
25198
25732
  operationId: UpdateCostAzureUCConfigs
@@ -25233,10 +25767,6 @@ paths:
25233
25767
  summary: Update Cloud Cost Management Azure config
25234
25768
  tags:
25235
25769
  - Cloud Cost Management
25236
- x-permission:
25237
- operator: OR
25238
- permissions:
25239
- - CLOUD_COST_MANAGEMENT_WRITE
25240
25770
  /api/v2/cost/enabled:
25241
25771
  get:
25242
25772
  description: Get the Cloud Cost Management activity.
@@ -25264,10 +25794,6 @@ paths:
25264
25794
  summary: Cloud Cost Enabled
25265
25795
  tags:
25266
25796
  - Cloud Cost Management
25267
- x-permission:
25268
- operator: OR
25269
- permissions:
25270
- - CLOUD_COST_MANAGEMENT_READ
25271
25797
  /api/v2/cost_by_tag/active_billing_dimensions:
25272
25798
  get:
25273
25799
  description: Get active billing dimensions for cost attribution. Cost data for
@@ -25842,9 +26368,9 @@ paths:
25842
26368
  tags:
25843
26369
  - DORA Metrics
25844
26370
  x-codegen-request-body-name: body
25845
- x-unstable: '**Note**: This endpoint is in private beta.
26371
+ x-unstable: '**Note**: This endpoint is in public beta.
25846
26372
 
25847
- If you want to request access, complete the [form](https://forms.gle/Eqq6uXfGjYxmqpjDA).'
26373
+ If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
25848
26374
  /api/v2/dora/incident:
25849
26375
  post:
25850
26376
  description: 'Use this API endpoint to provide data about incidents for DORA
@@ -25892,9 +26418,9 @@ paths:
25892
26418
  tags:
25893
26419
  - DORA Metrics
25894
26420
  x-codegen-request-body-name: body
25895
- x-unstable: '**Note**: This endpoint is in private beta.
26421
+ x-unstable: '**Note**: This endpoint is in public beta.
25896
26422
 
25897
- If you want to request access, complete the [form](https://forms.gle/Eqq6uXfGjYxmqpjDA).'
26423
+ If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
25898
26424
  /api/v2/downtime:
25899
26425
  get:
25900
26426
  description: Get all scheduled downtimes.
@@ -27595,10 +28121,6 @@ paths:
27595
28121
  tags:
27596
28122
  - Confluent Cloud
27597
28123
  x-codegen-request-body-name: body
27598
- x-permission:
27599
- operator: OR
27600
- permissions:
27601
- - STANDARD
27602
28124
  /api/v2/integrations/fastly/accounts:
27603
28125
  get:
27604
28126
  description: List Fastly accounts.
@@ -29995,6 +30517,96 @@ paths:
29995
30517
  limitParam: page[limit]
29996
30518
  pageOffsetParam: page[offset]
29997
30519
  resultsPath: data
30520
+ /api/v2/org_configs:
30521
+ get:
30522
+ description: Returns all Org Configs (name, description, and value).
30523
+ operationId: ListOrgConfigs
30524
+ responses:
30525
+ '200':
30526
+ content:
30527
+ application/json:
30528
+ schema:
30529
+ $ref: '#/components/schemas/OrgConfigListResponse'
30530
+ description: OK
30531
+ '400':
30532
+ $ref: '#/components/responses/BadRequestResponse'
30533
+ '401':
30534
+ $ref: '#/components/responses/UnauthorizedResponse'
30535
+ '403':
30536
+ $ref: '#/components/responses/ForbiddenResponse'
30537
+ '429':
30538
+ $ref: '#/components/responses/TooManyRequestsResponse'
30539
+ security:
30540
+ - apiKeyAuth: []
30541
+ appKeyAuth: []
30542
+ summary: List Org Configs
30543
+ tags:
30544
+ - Organizations
30545
+ /api/v2/org_configs/{org_config_name}:
30546
+ get:
30547
+ description: Return the name, description, and value of a specific Org Config.
30548
+ operationId: GetOrgConfig
30549
+ parameters:
30550
+ - $ref: '#/components/parameters/OrgConfigName'
30551
+ responses:
30552
+ '200':
30553
+ content:
30554
+ application/json:
30555
+ schema:
30556
+ $ref: '#/components/schemas/OrgConfigGetResponse'
30557
+ description: OK
30558
+ '400':
30559
+ $ref: '#/components/responses/BadRequestResponse'
30560
+ '401':
30561
+ $ref: '#/components/responses/UnauthorizedResponse'
30562
+ '403':
30563
+ $ref: '#/components/responses/ForbiddenResponse'
30564
+ '404':
30565
+ $ref: '#/components/responses/NotFoundResponse'
30566
+ '429':
30567
+ $ref: '#/components/responses/TooManyRequestsResponse'
30568
+ security:
30569
+ - apiKeyAuth: []
30570
+ appKeyAuth: []
30571
+ summary: Get a specific Org Config value
30572
+ tags:
30573
+ - Organizations
30574
+ patch:
30575
+ description: Update the value of a specific Org Config.
30576
+ operationId: UpdateOrgConfig
30577
+ parameters:
30578
+ - $ref: '#/components/parameters/OrgConfigName'
30579
+ requestBody:
30580
+ content:
30581
+ application/json:
30582
+ schema:
30583
+ $ref: '#/components/schemas/OrgConfigWriteRequest'
30584
+ required: true
30585
+ responses:
30586
+ '200':
30587
+ content:
30588
+ application/json:
30589
+ schema:
30590
+ $ref: '#/components/schemas/OrgConfigGetResponse'
30591
+ description: OK
30592
+ '400':
30593
+ $ref: '#/components/responses/BadRequestResponse'
30594
+ '401':
30595
+ $ref: '#/components/responses/UnauthorizedResponse'
30596
+ '403':
30597
+ $ref: '#/components/responses/ForbiddenResponse'
30598
+ '404':
30599
+ $ref: '#/components/responses/NotFoundResponse'
30600
+ '429':
30601
+ $ref: '#/components/responses/TooManyRequestsResponse'
30602
+ security:
30603
+ - apiKeyAuth: []
30604
+ appKeyAuth: []
30605
+ - AuthZ:
30606
+ - org_management
30607
+ summary: Update a specific Org Config
30608
+ tags:
30609
+ - Organizations
29998
30610
  /api/v2/permissions:
29999
30611
  get:
30000
30612
  description: Returns a list of all permissions, including name, description,
@@ -31156,7 +31768,6 @@ paths:
31156
31768
  tags:
31157
31769
  - Roles
31158
31770
  x-codegen-request-body-name: body
31159
- x-permission: OR(USER_ACCESS_MANAGE)
31160
31771
  /api/v2/roles/{role_id}/permissions:
31161
31772
  delete:
31162
31773
  description: Removes a permission from a role.
@@ -32541,6 +33152,42 @@ paths:
32541
33152
  tags:
32542
33153
  - Security Monitoring
32543
33154
  x-codegen-request-body-name: body
33155
+ /api/v2/security_monitoring/rules/test:
33156
+ post:
33157
+ description: Test a rule.
33158
+ operationId: TestSecurityMonitoringRule
33159
+ requestBody:
33160
+ content:
33161
+ application/json:
33162
+ schema:
33163
+ $ref: '#/components/schemas/SecurityMonitoringRuleTestRequest'
33164
+ required: true
33165
+ responses:
33166
+ '200':
33167
+ content:
33168
+ application/json:
33169
+ schema:
33170
+ $ref: '#/components/schemas/SecurityMonitoringRuleTestResponse'
33171
+ description: OK
33172
+ '400':
33173
+ $ref: '#/components/responses/BadRequestResponse'
33174
+ '401':
33175
+ $ref: '#/components/responses/ConcurrentModificationResponse'
33176
+ '403':
33177
+ $ref: '#/components/responses/NotAuthorizedResponse'
33178
+ '404':
33179
+ $ref: '#/components/responses/NotFoundResponse'
33180
+ '429':
33181
+ $ref: '#/components/responses/TooManyRequestsResponse'
33182
+ security:
33183
+ - apiKeyAuth: []
33184
+ appKeyAuth: []
33185
+ - AuthZ:
33186
+ - security_monitoring_rules_write
33187
+ summary: Test a rule
33188
+ tags:
33189
+ - Security Monitoring
33190
+ x-codegen-request-body-name: body
32544
33191
  /api/v2/security_monitoring/rules/validation:
32545
33192
  post:
32546
33193
  description: Validate a detection rule.
@@ -32549,7 +33196,7 @@ paths:
32549
33196
  content:
32550
33197
  application/json:
32551
33198
  schema:
32552
- $ref: '#/components/schemas/SecurityMonitoringRuleCreatePayload'
33199
+ $ref: '#/components/schemas/SecurityMonitoringRuleValidatePayload'
32553
33200
  required: true
32554
33201
  responses:
32555
33202
  '204':
@@ -32662,6 +33309,44 @@ paths:
32662
33309
  tags:
32663
33310
  - Security Monitoring
32664
33311
  x-codegen-request-body-name: body
33312
+ /api/v2/security_monitoring/rules/{rule_id}/test:
33313
+ post:
33314
+ description: Test an existing rule.
33315
+ operationId: TestExistingSecurityMonitoringRule
33316
+ parameters:
33317
+ - $ref: '#/components/parameters/SecurityMonitoringRuleID'
33318
+ requestBody:
33319
+ content:
33320
+ application/json:
33321
+ schema:
33322
+ $ref: '#/components/schemas/SecurityMonitoringRuleTestRequest'
33323
+ required: true
33324
+ responses:
33325
+ '200':
33326
+ content:
33327
+ application/json:
33328
+ schema:
33329
+ $ref: '#/components/schemas/SecurityMonitoringRuleTestResponse'
33330
+ description: OK
33331
+ '400':
33332
+ $ref: '#/components/responses/BadRequestResponse'
33333
+ '401':
33334
+ $ref: '#/components/responses/ConcurrentModificationResponse'
33335
+ '403':
33336
+ $ref: '#/components/responses/NotAuthorizedResponse'
33337
+ '404':
33338
+ $ref: '#/components/responses/NotFoundResponse'
33339
+ '429':
33340
+ $ref: '#/components/responses/TooManyRequestsResponse'
33341
+ security:
33342
+ - apiKeyAuth: []
33343
+ appKeyAuth: []
33344
+ - AuthZ:
33345
+ - security_monitoring_rules_write
33346
+ summary: Test an existing rule
33347
+ tags:
33348
+ - Security Monitoring
33349
+ x-codegen-request-body-name: body
32665
33350
  /api/v2/security_monitoring/signals:
32666
33351
  get:
32667
33352
  description: 'The list endpoint returns security signals that match a search