datadog_api_client 2.39.0 → 2.40.0

data/.generator/src/generator/cli.py

@@ -51,6 +51,7 @@ def cli(specs, output):
     env.globals["get_default"] = openapi.get_default
     env.globals["get_container"] = openapi.get_container
     env.globals["get_type_at_path"] = openapi.get_type_at_path
+    env.globals["get_security_names"] = openapi.get_security_names
 
     api_j2 = env.get_template("api.j2")
     model_j2 = env.get_template("model.j2")

data/.generator/src/generator/openapi.py

@@ -502,3 +502,15 @@ def get_type_at_path(operation, attribute_path):
     for attr in attribute_path.split("."):
         content = content["properties"][attr]
     return get_name(content.get("items"))
+
+
+def get_security_names(security):
+    if security is None:
+        return []
+
+    auth_names = set()
+    for auth in security:
+        for key in auth.keys() if isinstance(auth, dict) else [auth]:
+            auth_names.add(key)
+
+    return list(auth_names)

data/.generator/src/generator/templates/api.j2

@@ -195,7 +195,7 @@ module {{ module_name }}::{{ version|upper }}
 
       # auth_names
       {%- set authMethods = operation.security if "security" in operation else openapi.security %}
-      auth_names = opts[:debug_auth_names] || [{% for auth in (authMethods or []) %}:{{ ", :".join(auth.keys()) }}{%- if not loop.last %}, {% endif %}{% endfor %}]
+      auth_names = opts[:debug_auth_names] || [{% for auth in get_security_names(authMethods)|sort %}:{{ auth }}{%- if not loop.last %}, {% endif %}{% endfor %}]
 
       new_options = opts.merge(
         :operation => :{{ operation.operationId|snake_case }},

data/CHANGELOG.md

@@ -1,5 +1,31 @@
 # CHANGELOG
 
+## 2.40.0/2025-08-12
+
+### Added
+* Add Flex_Logs_Compute_XL to API Spec [#2585](https://github.com/DataDog/datadog-api-client-ruby/pull/2585)
+* Support Host and IaC finding types in security notifications  [#2584](https://github.com/DataDog/datadog-api-client-ruby/pull/2584)
+* New keys for summary public endpoint for Event Management Correlation product [#2580](https://github.com/DataDog/datadog-api-client-ruby/pull/2580)
+* Add log autosubscription tag filters config to aws v2 API [#2576](https://github.com/DataDog/datadog-api-client-ruby/pull/2576)
+* Extended List Findings API to expose resource related Private IP Addresses to details [#2569](https://github.com/DataDog/datadog-api-client-ruby/pull/2569)
+* update metrics.yaml for ListMetricAssets and include Dashboard info [#2564](https://github.com/DataDog/datadog-api-client-ruby/pull/2564)
+* Support Cloud SIEM scheduled rules in API client [#2561](https://github.com/DataDog/datadog-api-client-ruby/pull/2561)
+* Uncomment edit dataset block, add dataset limitations into endpoint descriptions  [#2559](https://github.com/DataDog/datadog-api-client-ruby/pull/2559)
+* Add `text` field in synthetics search endpoint [#2558](https://github.com/DataDog/datadog-api-client-ruby/pull/2558)
+* Adding all action connection types to public API [#2557](https://github.com/DataDog/datadog-api-client-ruby/pull/2557)
+* Document case management attributes endpoints [#2554](https://github.com/DataDog/datadog-api-client-ruby/pull/2554)
+* add AP2 endpoint for On-Call Paging [#2551](https://github.com/DataDog/datadog-api-client-ruby/pull/2551)
+* Flag IP case action [#2549](https://github.com/DataDog/datadog-api-client-ruby/pull/2549)
+* Add DNS specs for Cloud Network Monitoring API [#2547](https://github.com/DataDog/datadog-api-client-ruby/pull/2547)
+
+### Fixed
+* Split Dataset into separate request and response objects, mark unstable [#2568](https://github.com/DataDog/datadog-api-client-ruby/pull/2568)
+* Disables some tests to avoid fails as the service is disabled [#2563](https://github.com/DataDog/datadog-api-client-ruby/pull/2563)
+* OP make 'support_rules' field in parse_grok processor optional [#2552](https://github.com/DataDog/datadog-api-client-ruby/pull/2552)
+
+### Deprecated
+* Deprecate signals triage v1 endpoints [#2565](https://github.com/DataDog/datadog-api-client-ruby/pull/2565)
+
 ## 2.39.0/2025-07-14
 
 ### Added

data/Gemfile

@@ -9,6 +9,7 @@ group :development, :test do
   gem 'bigdecimal', '= 3.1.9'
   gem 'cucumber', '~> 9.2.1'
   gem 'datadog-ci', '~> 1.11'
+  gem 'libddwaf', '= 1.18.0.0.1'
   gem 'gem-release'
   gem 'rake', '~> 13.0.1'
   gem 'ostruct'

data/examples/v1/logs-pipelines/CreateLogsPipeline_3336967838.rb

@@ -0,0 +1,24 @@
+# Create a pipeline with Decoder Processor returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V1::LogsPipelinesAPI.new
+
+body = DatadogAPIClient::V1::LogsPipeline.new({
+  filter: DatadogAPIClient::V1::LogsFilter.new({
+    query: "source:python",
+  }),
+  name: "testDecoderProcessor",
+  processors: [
+    DatadogAPIClient::V1::LogsDecoderProcessor.new({
+      type: DatadogAPIClient::V1::LogsDecoderProcessorType::DECODER_PROCESSOR,
+      is_enabled: true,
+      name: "test_decoder",
+      source: "encoded.field",
+      target: "decoded.field",
+      binary_to_text_encoding: DatadogAPIClient::V1::LogsDecoderProcessorBinaryToTextEncoding::BASE16,
+      input_representation: DatadogAPIClient::V1::LogsDecoderProcessorInputRepresentation::UTF_8,
+    }),
+  ],
+  tags: [],
+})
+p api_instance.create_logs_pipeline(body)

data/examples/v1/synthetics/CreateSyntheticsAPITest_1072503741.rb

@@ -25,6 +25,7 @@ body = DatadogAPIClient::V1::SyntheticsAPITest.new({
   options: DatadogAPIClient::V1::SyntheticsTestOptions.new({
     accept_self_signed: true,
     check_certificate_revocation: true,
+    disable_aia_intermediate_fetching: true,
     tick_every: 60,
   }),
   subtype: DatadogAPIClient::V1::SyntheticsTestDetailsSubType::SSL,

data/examples/v1/synthetics/CreateSyntheticsAPITest_1279271422.rb

@@ -101,6 +101,7 @@ body = DatadogAPIClient::V1::SyntheticsAPITest.new({
         ],
         request: DatadogAPIClient::V1::SyntheticsTestRequest.new({
           check_certificate_revocation: true,
+          disable_aia_intermediate_fetching: true,
           host: "example.org",
           port: 443,
         }),

data/examples/v1/synthetics/SearchTests_195957771.rb

@@ -3,6 +3,7 @@
 require "datadog_api_client"
 api_instance = DatadogAPIClient::V1::SyntheticsAPI.new
 opts = {
+  text: "tag:value",
   include_full_config: true,
   search_suites: true,
   facets_only: true,

data/examples/v2/aws-integration/CreateAWSAccount.rb

@@ -23,6 +23,16 @@ body = DatadogAPIClient::V2::AWSAccountCreateRequest.new({
           lambdas: [
             "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder",
           ],
+          log_source_config: DatadogAPIClient::V2::AWSLambdaForwarderConfigLogSourceConfig.new({
+            tag_filters: [
+              DatadogAPIClient::V2::AWSLogSourceTagFilter.new({
+                source: "s3",
+                tags: [
+                  "test:test",
+                ],
+              }),
+            ],
+          }),
           sources: [
             "s3",
           ],

data/examples/v2/aws-integration/CreateAWSAccount_1716720881.rb

@@ -22,6 +22,16 @@ body = DatadogAPIClient::V2::AWSAccountCreateRequest.new({
           lambdas: [
             "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder",
           ],
+          log_source_config: DatadogAPIClient::V2::AWSLambdaForwarderConfigLogSourceConfig.new({
+            tag_filters: [
+              DatadogAPIClient::V2::AWSLogSourceTagFilter.new({
+                source: "s3",
+                tags: [
+                  "test:test",
+                ],
+              }),
+            ],
+          }),
           sources: [
             "s3",
           ],

data/examples/v2/aws-integration/UpdateAWSAccount.rb

@@ -25,6 +25,16 @@ body = DatadogAPIClient::V2::AWSAccountUpdateRequest.new({
           lambdas: [
             "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder",
           ],
+          log_source_config: DatadogAPIClient::V2::AWSLambdaForwarderConfigLogSourceConfig.new({
+            tag_filters: [
+              DatadogAPIClient::V2::AWSLogSourceTagFilter.new({
+                source: "s3",
+                tags: [
+                  "test:test",
+                ],
+              }),
+            ],
+          }),
           sources: [
             "s3",
           ],

data/examples/v2/case-management/UpdateAttributes.rb

@@ -0,0 +1,26 @@
+# Update case attributes returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::CaseManagementAPI.new
+
+# there is a valid "case" in the system
+CASE_ID = ENV["CASE_ID"]
+
+body = DatadogAPIClient::V2::CaseUpdateAttributesRequest.new({
+  data: DatadogAPIClient::V2::CaseUpdateAttributes.new({
+    attributes: DatadogAPIClient::V2::CaseUpdateAttributesAttributes.new({
+      attributes: {
+        env: [
+          "test",
+        ], service: [
+          "web-store",
+          "web-api",
+        ], team: [
+          "engineer",
+        ],
+      },
+    }),
+    type: DatadogAPIClient::V2::CaseResourceType::CASE,
+  }),
+})
+p api_instance.update_attributes(CASE_ID, body)

data/examples/v2/cloud-network-monitoring/GetAggregatedConnections.rb

@@ -1,8 +1,5 @@
 # Get all aggregated connections returns "OK" response
 
 require "datadog_api_client"
-DatadogAPIClient.configure do |config|
-  config.unstable_operations["v2.get_aggregated_connections".to_sym] = true
-end
 api_instance = DatadogAPIClient::V2::CloudNetworkMonitoringAPI.new
 p api_instance.get_aggregated_connections()

data/examples/v2/cloud-network-monitoring/GetAggregatedConnections_3059356111.rb

@@ -1,8 +1,5 @@
 # Get aggregated connections returns "OK" response
 
 require "datadog_api_client"
-DatadogAPIClient.configure do |config|
-  config.unstable_operations["v2.get_aggregated_connections".to_sym] = true
-end
 api_instance = DatadogAPIClient::V2::CloudNetworkMonitoringAPI.new
 p api_instance.get_aggregated_connections()

data/examples/v2/cloud-network-monitoring/GetAggregatedDns.rb

@@ -0,0 +1,5 @@
+# Get all aggregated DNS traffic returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::CloudNetworkMonitoringAPI.new
+p api_instance.get_aggregated_dns()

data/examples/v2/datasets/CreateDataset.rb

@@ -1,26 +1,27 @@
 # Create a dataset returns "OK" response
 
 require "datadog_api_client"
+DatadogAPIClient.configure do |config|
+  config.unstable_operations["v2.create_dataset".to_sym] = true
+end
 api_instance = DatadogAPIClient::V2::DatasetsAPI.new
 
 body = DatadogAPIClient::V2::DatasetCreateRequest.new({
-  data: DatadogAPIClient::V2::Dataset.new({
-    attributes: DatadogAPIClient::V2::DatasetAttributes.new({
-      created_at: nil,
+  data: DatadogAPIClient::V2::DatasetRequest.new({
+    attributes: DatadogAPIClient::V2::DatasetAttributesRequest.new({
       name: "Security Audit Dataset",
       principals: [
-        "role:86245fce-0a4e-11f0-92bd-da7ad0900002",
+        "role:94172442-be03-11e9-a77a-3b7612558ac1",
       ],
       product_filters: [
         DatadogAPIClient::V2::FiltersPerProduct.new({
           filters: [
             "@application.id:ABCD",
           ],
-          product: "logs",
+          product: "metrics",
         }),
       ],
     }),
-    id: "123e4567-e89b-12d3-a456-426614174000",
     type: "dataset",
   }),
 })

data/examples/v2/datasets/DeleteDataset.rb

@@ -1,5 +1,11 @@
 # Delete a dataset returns "No Content" response
 
 require "datadog_api_client"
+DatadogAPIClient.configure do |config|
+  config.unstable_operations["v2.delete_dataset".to_sym] = true
+end
 api_instance = DatadogAPIClient::V2::DatasetsAPI.new
-api_instance.delete_dataset("dataset_id")
+
+# there is a valid "dataset" in the system
+DATASET_DATA_ID = ENV["DATASET_DATA_ID"]
+api_instance.delete_dataset(DATASET_DATA_ID)

data/examples/v2/datasets/GetAllDatasets.rb

@@ -1,5 +1,8 @@
 # Get all datasets returns "OK" response
 
 require "datadog_api_client"
+DatadogAPIClient.configure do |config|
+  config.unstable_operations["v2.get_all_datasets".to_sym] = true
+end
 api_instance = DatadogAPIClient::V2::DatasetsAPI.new
 p api_instance.get_all_datasets()

data/examples/v2/datasets/GetDataset.rb

@@ -1,5 +1,11 @@
 # Get a single dataset by ID returns "OK" response
 
 require "datadog_api_client"
+DatadogAPIClient.configure do |config|
+  config.unstable_operations["v2.get_dataset".to_sym] = true
+end
 api_instance = DatadogAPIClient::V2::DatasetsAPI.new
-p api_instance.get_dataset("dataset_id")
+
+# there is a valid "dataset" in the system
+DATASET_DATA_ID = ENV["DATASET_DATA_ID"]
+p api_instance.get_dataset(DATASET_DATA_ID)

data/examples/v2/datasets/UpdateDataset.rb

@@ -0,0 +1,31 @@
+# Edit a dataset returns "OK" response
+
+require "datadog_api_client"
+DatadogAPIClient.configure do |config|
+  config.unstable_operations["v2.update_dataset".to_sym] = true
+end
+api_instance = DatadogAPIClient::V2::DatasetsAPI.new
+
+# there is a valid "dataset" in the system
+DATASET_DATA_ID = ENV["DATASET_DATA_ID"]
+
+body = DatadogAPIClient::V2::DatasetUpdateRequest.new({
+  data: DatadogAPIClient::V2::DatasetRequest.new({
+    attributes: DatadogAPIClient::V2::DatasetAttributesRequest.new({
+      name: "Security Audit Dataset",
+      principals: [
+        "role:94172442-be03-11e9-a77a-3b7612558ac1",
+      ],
+      product_filters: [
+        DatadogAPIClient::V2::FiltersPerProduct.new({
+          filters: [
+            "@application.id:1234",
+          ],
+          product: "metrics",
+        }),
+      ],
+    }),
+    type: "dataset",
+  }),
+})
+p api_instance.update_dataset(DATASET_DATA_ID, body)

data/examples/v2/events/GetEvent.rb

@@ -0,0 +1,5 @@
+# Get an event returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::EventsAPI.new
+p api_instance.get_event("AZeF-nTCAABzkAgGXzYPtgAA")

data/examples/v2/metrics/GetMetricTagCardinalityDetails.rb

@@ -0,0 +1,5 @@
+# Get tag key cardinality details returns "Success" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::MetricsAPI.new
+p api_instance.get_metric_tag_cardinality_details("metric_name")

data/examples/v2/security-monitoring/CreateSecurityMonitoringRule_1965169892.rb

@@ -37,6 +37,12 @@ body = DatadogAPIClient::V2::SecurityMonitoringStandardRuleCreatePayload.new({
             user_behavior_name: "behavior",
           }),
         }),
+        DatadogAPIClient::V2::SecurityMonitoringRuleCaseAction.new({
+          type: DatadogAPIClient::V2::SecurityMonitoringRuleCaseActionType::FLAG_IP,
+          options: DatadogAPIClient::V2::SecurityMonitoringRuleCaseActionOptions.new({
+            flagged_ip_type: DatadogAPIClient::V2::SecurityMonitoringRuleCaseActionOptionsFlaggedIPType::FLAGGED,
+          }),
+        }),
       ],
     }),
   ],

data/examples/v2/security-monitoring/CreateSecurityMonitoringRule_868881438.rb

@@ -0,0 +1,41 @@
+# Create a scheduled detection rule returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::SecurityMonitoringAPI.new
+
+body = DatadogAPIClient::V2::SecurityMonitoringStandardRuleCreatePayload.new({
+  name: "Example-Security-Monitoring",
+  queries: [
+    DatadogAPIClient::V2::SecurityMonitoringStandardRuleQuery.new({
+      query: "@test:true",
+      aggregation: DatadogAPIClient::V2::SecurityMonitoringRuleQueryAggregation::COUNT,
+      group_by_fields: [],
+      distinct_fields: [],
+      index: "main",
+    }),
+  ],
+  filters: [],
+  cases: [
+    DatadogAPIClient::V2::SecurityMonitoringRuleCaseCreate.new({
+      name: "",
+      status: DatadogAPIClient::V2::SecurityMonitoringRuleSeverity::INFO,
+      condition: "a > 0",
+      notifications: [],
+    }),
+  ],
+  options: DatadogAPIClient::V2::SecurityMonitoringRuleOptions.new({
+    evaluation_window: DatadogAPIClient::V2::SecurityMonitoringRuleEvaluationWindow::FIFTEEN_MINUTES,
+    keep_alive: DatadogAPIClient::V2::SecurityMonitoringRuleKeepAlive::ONE_HOUR,
+    max_signal_duration: DatadogAPIClient::V2::SecurityMonitoringRuleMaxSignalDuration::ONE_DAY,
+  }),
+  message: "Test rule",
+  tags: [],
+  is_enabled: true,
+  type: DatadogAPIClient::V2::SecurityMonitoringRuleTypeCreate::LOG_DETECTION,
+  scheduling_options: DatadogAPIClient::V2::SecurityMonitoringSchedulingOptions.new({
+    rrule: "FREQ=HOURLY;INTERVAL=2;",
+    start: "2025-06-18T12:00:00",
+    timezone: "Europe/Paris",
+  }),
+})
+p api_instance.create_security_monitoring_rule(body)

data/lib/datadog_api_client/configuration.rb

@@ -208,6 +208,11 @@ module DatadogAPIClient
             "v2.list_vulnerable_assets": false,
             "v2.mute_findings": false,
             "v2.run_historical_job": false,
+            "v2.create_dataset": false,
+            "v2.delete_dataset": false,
+            "v2.get_all_datasets": false,
+            "v2.get_dataset": false,
+            "v2.update_dataset": false,
             "v2.cancel_data_deletion_request": false,
             "v2.create_data_deletion_request": false,
             "v2.get_data_deletion_requests": false,
@@ -249,7 +254,6 @@ module DatadogAPIClient
             "v2.update_monitor_user_template": false,
             "v2.validate_existing_monitor_user_template": false,
             "v2.validate_monitor_user_template": false,
-            "v2.get_aggregated_connections": false,
             "v2.create_pipeline": false,
             "v2.delete_pipeline": false,
             "v2.get_pipeline": false,
@@ -655,6 +659,7 @@ module DatadogAPIClient
                 description: "The globally available endpoint for On-Call.",
                 default_value: "navy.oncall.datadoghq.com",
                 enum_values: [
+                  "lava.oncall.datadoghq.com",
                   "saffron.oncall.datadoghq.com",
                   "navy.oncall.datadoghq.com",
                   "coral.oncall.datadoghq.com",
@@ -702,6 +707,7 @@ module DatadogAPIClient
                 description: "The globally available endpoint for On-Call.",
                 default_value: "navy.oncall.datadoghq.com",
                 enum_values: [
+                  "lava.oncall.datadoghq.com",
                   "saffron.oncall.datadoghq.com",
                   "navy.oncall.datadoghq.com",
                   "coral.oncall.datadoghq.com",
@@ -749,6 +755,7 @@ module DatadogAPIClient
                 description: "The globally available endpoint for On-Call.",
                 default_value: "navy.oncall.datadoghq.com",
                 enum_values: [
+                  "lava.oncall.datadoghq.com",
                   "saffron.oncall.datadoghq.com",
                   "navy.oncall.datadoghq.com",
                   "coral.oncall.datadoghq.com",
@@ -796,6 +803,7 @@ module DatadogAPIClient
                 description: "The globally available endpoint for On-Call.",
                 default_value: "navy.oncall.datadoghq.com",
                 enum_values: [
+                  "lava.oncall.datadoghq.com",
                   "saffron.oncall.datadoghq.com",
                   "navy.oncall.datadoghq.com",
                   "coral.oncall.datadoghq.com",