datadog_api_client 2.29.1 → 2.30.0

data/examples/v2/microsoft-teams-integration/CreateWorkflowsWebhookHandle.rb

@@ -0,0 +1,15 @@
+# Create Workflows webhook handle returns "CREATED" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::MicrosoftTeamsIntegrationAPI.new
+
+body = DatadogAPIClient::V2::MicrosoftTeamsCreateWorkflowsWebhookHandleRequest.new({
+  data: DatadogAPIClient::V2::MicrosoftTeamsWorkflowsWebhookHandleRequestData.new({
+    attributes: DatadogAPIClient::V2::MicrosoftTeamsWorkflowsWebhookHandleRequestAttributes.new({
+      name: "fake-handle-name",
+      url: "https://fake.url.com",
+    }),
+    type: DatadogAPIClient::V2::MicrosoftTeamsWorkflowsWebhookHandleType::WORKFLOWS_WEBHOOK_HANDLE,
+  }),
+})
+p api_instance.create_workflows_webhook_handle(body)

data/examples/v2/microsoft-teams-integration/CreateWorkflowsWebhookHandle_1716851881.rb

@@ -0,0 +1,15 @@
+# Create workflow webhook handle returns "CREATED" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::MicrosoftTeamsIntegrationAPI.new
+
+body = DatadogAPIClient::V2::MicrosoftTeamsCreateWorkflowsWebhookHandleRequest.new({
+  data: DatadogAPIClient::V2::MicrosoftTeamsWorkflowsWebhookHandleRequestData.new({
+    attributes: DatadogAPIClient::V2::MicrosoftTeamsWorkflowsWebhookHandleRequestAttributes.new({
+      name: "Example-Microsoft-Teams-Integration",
+      url: "https://fake.url.com",
+    }),
+    type: DatadogAPIClient::V2::MicrosoftTeamsWorkflowsWebhookHandleType::WORKFLOWS_WEBHOOK_HANDLE,
+  }),
+})
+p api_instance.create_workflows_webhook_handle(body)

data/examples/v2/microsoft-teams-integration/DeleteWorkflowsWebhookHandle.rb

@@ -0,0 +1,5 @@
+# Delete Workflows webhook handle returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::MicrosoftTeamsIntegrationAPI.new
+api_instance.delete_workflows_webhook_handle("handle_id")

data/examples/v2/microsoft-teams-integration/DeleteWorkflowsWebhookHandle_107549514.rb

@@ -0,0 +1,8 @@
+# Delete workflow webhook handle returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::MicrosoftTeamsIntegrationAPI.new
+
+# there is a valid "workflows_webhook_handle" in the system
+WORKFLOWS_WEBHOOK_HANDLE_DATA_ID = ENV["WORKFLOWS_WEBHOOK_HANDLE_DATA_ID"]
+api_instance.delete_workflows_webhook_handle(WORKFLOWS_WEBHOOK_HANDLE_DATA_ID)

data/examples/v2/microsoft-teams-integration/GetWorkflowsWebhookHandle.rb

@@ -0,0 +1,5 @@
+# Get Workflows webhook handle information returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::MicrosoftTeamsIntegrationAPI.new
+p api_instance.get_workflows_webhook_handle("handle_id")

data/examples/v2/microsoft-teams-integration/GetWorkflowsWebhookHandle_3421443805.rb

@@ -0,0 +1,8 @@
+# Get workflow webhook handle information returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::MicrosoftTeamsIntegrationAPI.new
+
+# there is a valid "workflows_webhook_handle" in the system
+WORKFLOWS_WEBHOOK_HANDLE_DATA_ID = ENV["WORKFLOWS_WEBHOOK_HANDLE_DATA_ID"]
+p api_instance.get_workflows_webhook_handle(WORKFLOWS_WEBHOOK_HANDLE_DATA_ID)

data/examples/v2/microsoft-teams-integration/ListWorkflowsWebhookHandles.rb

@@ -0,0 +1,5 @@
+# Get all Workflows webhook handles returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::MicrosoftTeamsIntegrationAPI.new
+p api_instance.list_workflows_webhook_handles()

data/examples/v2/microsoft-teams-integration/ListWorkflowsWebhookHandles_620762083.rb

@@ -0,0 +1,5 @@
+# Get all workflow webhook handles returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::MicrosoftTeamsIntegrationAPI.new
+p api_instance.list_workflows_webhook_handles()

data/examples/v2/microsoft-teams-integration/UpdateWorkflowsWebhookHandle.rb

@@ -0,0 +1,15 @@
+# Update Workflows webhook handle returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::MicrosoftTeamsIntegrationAPI.new
+
+body = DatadogAPIClient::V2::MicrosoftTeamsUpdateWorkflowsWebhookHandleRequest.new({
+  data: DatadogAPIClient::V2::MicrosoftTeamsUpdateWorkflowsWebhookHandleRequestData.new({
+    attributes: DatadogAPIClient::V2::MicrosoftTeamsWorkflowsWebhookHandleAttributes.new({
+      name: "fake-handle-name",
+      url: "https://fake.url.com",
+    }),
+    type: DatadogAPIClient::V2::MicrosoftTeamsWorkflowsWebhookHandleType::WORKFLOWS_WEBHOOK_HANDLE,
+  }),
+})
+p api_instance.update_workflows_webhook_handle("handle_id", body)

data/examples/v2/microsoft-teams-integration/UpdateWorkflowsWebhookHandle_163189594.rb

@@ -0,0 +1,18 @@
+# Update workflow webhook handle returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::MicrosoftTeamsIntegrationAPI.new
+
+# there is a valid "workflows_webhook_handle" in the system
+WORKFLOWS_WEBHOOK_HANDLE_DATA_ATTRIBUTES_NAME = ENV["WORKFLOWS_WEBHOOK_HANDLE_DATA_ATTRIBUTES_NAME"]
+WORKFLOWS_WEBHOOK_HANDLE_DATA_ID = ENV["WORKFLOWS_WEBHOOK_HANDLE_DATA_ID"]
+
+body = DatadogAPIClient::V2::MicrosoftTeamsUpdateWorkflowsWebhookHandleRequest.new({
+  data: DatadogAPIClient::V2::MicrosoftTeamsUpdateWorkflowsWebhookHandleRequestData.new({
+    attributes: DatadogAPIClient::V2::MicrosoftTeamsWorkflowsWebhookHandleAttributes.new({
+      name: "fake-handle-name--updated",
+    }),
+    type: DatadogAPIClient::V2::MicrosoftTeamsWorkflowsWebhookHandleType::WORKFLOWS_WEBHOOK_HANDLE,
+  }),
+})
+p api_instance.update_workflows_webhook_handle(WORKFLOWS_WEBHOOK_HANDLE_DATA_ID, body)

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

@@ -8,6 +8,7 @@ body = DatadogAPIClient::V2::SecurityMonitoringSuppressionCreateRequest.new({
     attributes: DatadogAPIClient::V2::SecurityMonitoringSuppressionCreateAttributes.new({
       description: "This rule suppresses low-severity signals in staging environments.",
       enabled: true,
+      start_date: 1637493071000,
       expiration_date: 1638443471000,
       name: "Example-Security-Monitoring",
       rule_query: "type:log_detection source:cloudtrail",

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

@@ -8,6 +8,7 @@ body = DatadogAPIClient::V2::SecurityMonitoringSuppressionCreateRequest.new({
     attributes: DatadogAPIClient::V2::SecurityMonitoringSuppressionCreateAttributes.new({
       description: "This rule suppresses low-severity signals in staging environments.",
       enabled: true,
+      start_date: 1637493071000,
       expiration_date: 1638443471000,
       name: "Example-Security-Monitoring",
       rule_query: "type:log_detection source:cloudtrail",

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

@@ -0,0 +1,30 @@
+# Create a new signal-based rule returns "Successfully created the notification rule." response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::SecurityMonitoringAPI.new
+
+body = DatadogAPIClient::V2::CreateNotificationRuleParameters.new({
+  data: DatadogAPIClient::V2::CreateNotificationRuleParametersData.new({
+    attributes: DatadogAPIClient::V2::CreateNotificationRuleParametersDataAttributes.new({
+      enabled: true,
+      name: "Rule 1",
+      selectors: DatadogAPIClient::V2::Selectors.new({
+        query: "(source:production_service OR env:prod)",
+        rule_types: [
+          DatadogAPIClient::V2::RuleTypesItems::MISCONFIGURATION,
+          DatadogAPIClient::V2::RuleTypesItems::ATTACK_PATH,
+        ],
+        severities: [
+          DatadogAPIClient::V2::RuleSeverity::CRITICAL,
+        ],
+        trigger_source: DatadogAPIClient::V2::TriggerSource::SECURITY_FINDINGS,
+      }),
+      targets: [
+        "@john.doe@email.com",
+      ],
+      time_aggregation: 86400,
+    }),
+    type: DatadogAPIClient::V2::NotificationRulesType::NOTIFICATION_RULES,
+  }),
+})
+p api_instance.create_signal_notification_rule(body)

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

@@ -0,0 +1,30 @@
+# Create a new vulnerability-based rule returns "Successfully created the notification rule." response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::SecurityMonitoringAPI.new
+
+body = DatadogAPIClient::V2::CreateNotificationRuleParameters.new({
+  data: DatadogAPIClient::V2::CreateNotificationRuleParametersData.new({
+    attributes: DatadogAPIClient::V2::CreateNotificationRuleParametersDataAttributes.new({
+      enabled: true,
+      name: "Rule 1",
+      selectors: DatadogAPIClient::V2::Selectors.new({
+        query: "(source:production_service OR env:prod)",
+        rule_types: [
+          DatadogAPIClient::V2::RuleTypesItems::MISCONFIGURATION,
+          DatadogAPIClient::V2::RuleTypesItems::ATTACK_PATH,
+        ],
+        severities: [
+          DatadogAPIClient::V2::RuleSeverity::CRITICAL,
+        ],
+        trigger_source: DatadogAPIClient::V2::TriggerSource::SECURITY_FINDINGS,
+      }),
+      targets: [
+        "@john.doe@email.com",
+      ],
+      time_aggregation: 86400,
+    }),
+    type: DatadogAPIClient::V2::NotificationRulesType::NOTIFICATION_RULES,
+  }),
+})
+p api_instance.create_vulnerability_notification_rule(body)

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

@@ -0,0 +1,8 @@
+# Delete a signal-based rule returns "Rule successfully deleted." response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::SecurityMonitoringAPI.new
+
+# there is a valid "valid_signal_notification_rule" in the system
+VALID_SIGNAL_NOTIFICATION_RULE_DATA_ID = ENV["VALID_SIGNAL_NOTIFICATION_RULE_DATA_ID"]
+api_instance.delete_signal_notification_rule(VALID_SIGNAL_NOTIFICATION_RULE_DATA_ID)

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

@@ -0,0 +1,8 @@
+# Delete a vulnerability-based rule returns "Rule successfully deleted." response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::SecurityMonitoringAPI.new
+
+# there is a valid "valid_vulnerability_notification_rule" in the system
+VALID_VULNERABILITY_NOTIFICATION_RULE_DATA_ID = ENV["VALID_VULNERABILITY_NOTIFICATION_RULE_DATA_ID"]
+api_instance.delete_vulnerability_notification_rule(VALID_VULNERABILITY_NOTIFICATION_RULE_DATA_ID)

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

@@ -0,0 +1,5 @@
+# Get SBOM returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::SecurityMonitoringAPI.new
+p api_instance.get_sbom(AssetType::REPOSITORY, "github.com/datadog/datadog-agent")

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

@@ -0,0 +1,8 @@
+# Get details of a signal-based rule returns "Notification rule details." response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::SecurityMonitoringAPI.new
+
+# there is a valid "valid_signal_notification_rule" in the system
+VALID_SIGNAL_NOTIFICATION_RULE_DATA_ID = ENV["VALID_SIGNAL_NOTIFICATION_RULE_DATA_ID"]
+p api_instance.get_signal_notification_rule(VALID_SIGNAL_NOTIFICATION_RULE_DATA_ID)

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

@@ -0,0 +1,5 @@
+# Get the list of signal-based rules returns "The list of notification rules." response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::SecurityMonitoringAPI.new
+p api_instance.get_signal_notification_rules()

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

@@ -0,0 +1,8 @@
+# Get details of a vulnerability-based rule returns "Notification rule details." response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::SecurityMonitoringAPI.new
+
+# there is a valid "valid_vulnerability_notification_rule" in the system
+VALID_VULNERABILITY_NOTIFICATION_RULE_DATA_ID = ENV["VALID_VULNERABILITY_NOTIFICATION_RULE_DATA_ID"]
+p api_instance.get_vulnerability_notification_rule(VALID_VULNERABILITY_NOTIFICATION_RULE_DATA_ID)

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

@@ -0,0 +1,5 @@
+# Get the list of vulnerability-based rules returns "The list of notification rules." response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::SecurityMonitoringAPI.new
+p api_instance.get_vulnerability_notification_rules()

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

@@ -0,0 +1,10 @@
+# List vulnerabilities returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::SecurityMonitoringAPI.new
+opts = {
+  filter_cvss_base_severity: VulnerabilitySeverity::HIGH,
+  filter_asset_type: AssetType::SERVICE,
+  filter_tool: VulnerabilityTool::INFRA,
+}
+p api_instance.list_vulnerabilities(opts)

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

@@ -0,0 +1,10 @@
+# List vulnerable assets returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::SecurityMonitoringAPI.new
+opts = {
+  filter_type: AssetType::HOST,
+  filter_repository_url: "github.com/datadog/dd-go",
+  filter_risks_in_production: true,
+}
+p api_instance.list_vulnerable_assets(opts)

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

@@ -0,0 +1,35 @@
+# Patch a signal-based rule returns "Notification rule successfully patched." response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::SecurityMonitoringAPI.new
+
+# there is a valid "valid_signal_notification_rule" in the system
+VALID_SIGNAL_NOTIFICATION_RULE_DATA_ID = ENV["VALID_SIGNAL_NOTIFICATION_RULE_DATA_ID"]
+
+body = DatadogAPIClient::V2::PatchNotificationRuleParameters.new({
+  data: DatadogAPIClient::V2::PatchNotificationRuleParametersData.new({
+    attributes: DatadogAPIClient::V2::PatchNotificationRuleParametersDataAttributes.new({
+      enabled: true,
+      name: "Rule 1",
+      selectors: DatadogAPIClient::V2::Selectors.new({
+        query: "(source:production_service OR env:prod)",
+        rule_types: [
+          DatadogAPIClient::V2::RuleTypesItems::MISCONFIGURATION,
+          DatadogAPIClient::V2::RuleTypesItems::ATTACK_PATH,
+        ],
+        severities: [
+          DatadogAPIClient::V2::RuleSeverity::CRITICAL,
+        ],
+        trigger_source: DatadogAPIClient::V2::TriggerSource::SECURITY_FINDINGS,
+      }),
+      targets: [
+        "@john.doe@email.com",
+      ],
+      time_aggregation: 86400,
+      version: 1,
+    }),
+    id: VALID_SIGNAL_NOTIFICATION_RULE_DATA_ID,
+    type: DatadogAPIClient::V2::NotificationRulesType::NOTIFICATION_RULES,
+  }),
+})
+p api_instance.patch_signal_notification_rule(VALID_SIGNAL_NOTIFICATION_RULE_DATA_ID, body)

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

@@ -0,0 +1,35 @@
+# Patch a vulnerability-based rule returns "Notification rule successfully patched." response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::SecurityMonitoringAPI.new
+
+# there is a valid "valid_vulnerability_notification_rule" in the system
+VALID_VULNERABILITY_NOTIFICATION_RULE_DATA_ID = ENV["VALID_VULNERABILITY_NOTIFICATION_RULE_DATA_ID"]
+
+body = DatadogAPIClient::V2::PatchNotificationRuleParameters.new({
+  data: DatadogAPIClient::V2::PatchNotificationRuleParametersData.new({
+    attributes: DatadogAPIClient::V2::PatchNotificationRuleParametersDataAttributes.new({
+      enabled: true,
+      name: "Rule 1",
+      selectors: DatadogAPIClient::V2::Selectors.new({
+        query: "(source:production_service OR env:prod)",
+        rule_types: [
+          DatadogAPIClient::V2::RuleTypesItems::MISCONFIGURATION,
+          DatadogAPIClient::V2::RuleTypesItems::ATTACK_PATH,
+        ],
+        severities: [
+          DatadogAPIClient::V2::RuleSeverity::CRITICAL,
+        ],
+        trigger_source: DatadogAPIClient::V2::TriggerSource::SECURITY_FINDINGS,
+      }),
+      targets: [
+        "@john.doe@email.com",
+      ],
+      time_aggregation: 86400,
+      version: 1,
+    }),
+    id: VALID_VULNERABILITY_NOTIFICATION_RULE_DATA_ID,
+    type: DatadogAPIClient::V2::NotificationRulesType::NOTIFICATION_RULES,
+  }),
+})
+p api_instance.patch_vulnerability_notification_rule(VALID_VULNERABILITY_NOTIFICATION_RULE_DATA_ID, body)

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

@@ -14,7 +14,7 @@ body = DatadogAPIClient::V2::RunHistoricalJobRequest.new({
         type: "log_detection",
         name: "Excessive number of failed attempts.",
         queries: [
-          DatadogAPIClient::V2::SecurityMonitoringStandardRuleQuery.new({
+          DatadogAPIClient::V2::HistoricalJobQuery.new({
             query: "source:non_existing_src_weekend",
             aggregation: DatadogAPIClient::V2::SecurityMonitoringRuleQueryAggregation::COUNT,
             group_by_fields: [],
@@ -29,7 +29,7 @@ body = DatadogAPIClient::V2::RunHistoricalJobRequest.new({
             condition: "a > 1",
           }),
         ],
-        options: DatadogAPIClient::V2::SecurityMonitoringRuleOptions.new({
+        options: DatadogAPIClient::V2::HistoricalJobOptions.new({
           keep_alive: DatadogAPIClient::V2::SecurityMonitoringRuleKeepAlive::ONE_HOUR,
           max_signal_duration: DatadogAPIClient::V2::SecurityMonitoringRuleMaxSignalDuration::ONE_DAY,
           evaluation_window: DatadogAPIClient::V2::SecurityMonitoringRuleEvaluationWindow::FIFTEEN_MINUTES,

data/examples/v2/usage-metering/GetActiveBillingDimensions.rb

@@ -1,8 +1,5 @@
 # Get active billing dimensions for cost attribution returns "OK" response
 
 require "datadog_api_client"
-DatadogAPIClient.configure do |config|
-  config.unstable_operations["v2.get_active_billing_dimensions".to_sym] = true
-end
 api_instance = DatadogAPIClient::V2::UsageMeteringAPI.new
 p api_instance.get_active_billing_dimensions()

data/examples/v2/usage-metering/GetBillingDimensionMapping.rb

@@ -1,8 +1,5 @@
 # Get billing dimension mapping for usage endpoints returns "OK" response
 
 require "datadog_api_client"
-DatadogAPIClient.configure do |config|
-  config.unstable_operations["v2.get_billing_dimension_mapping".to_sym] = true
-end
 api_instance = DatadogAPIClient::V2::UsageMeteringAPI.new
 p api_instance.get_billing_dimension_mapping()

data/examples/v2/usage-metering/GetMonthlyCostAttribution.rb

@@ -1,9 +1,6 @@
 # Get Monthly Cost Attribution returns "OK" response
 
 require "datadog_api_client"
-DatadogAPIClient.configure do |config|
-  config.unstable_operations["v2.get_monthly_cost_attribution".to_sym] = true
-end
 api_instance = DatadogAPIClient::V2::UsageMeteringAPI.new
 opts = {
   end_month: (Time.now + -3 * 86400),

data/lib/datadog_api_client/configuration.rb

@@ -199,12 +199,9 @@ module DatadogAPIClient
             "v2.delete_apps": false,
             "v2.get_app": false,
             "v2.list_apps": false,
+            "v2.publish_app": false,
+            "v2.unpublish_app": false,
             "v2.update_app": false,
-            "v2.deploy_app": false,
-            "v2.disable_app": false,
-            "v2.get_active_billing_dimensions": false,
-            "v2.get_billing_dimension_mapping": false,
-            "v2.get_monthly_cost_attribution": false,
             "v2.cancel_data_deletion_request": false,
             "v2.create_data_deletion_request": false,
             "v2.get_data_deletion_requests": false,