datadog_api_client 2.17.0 → 2.19.0

data/examples/v2/dora-metrics/CreateDORADeployment.rb

@@ -0,0 +1,23 @@
+# Send a deployment event for DORA Metrics returns "OK" response
+
+require "datadog_api_client"
+DatadogAPIClient.configure do |config|
+  config.unstable_operations["v2.create_dora_deployment".to_sym] = true
+end
+api_instance = DatadogAPIClient::V2::DORAMetricsAPI.new
+
+body = DatadogAPIClient::V2::DORADeploymentRequest.new({
+  data: DatadogAPIClient::V2::DORADeploymentRequestData.new({
+    attributes: DatadogAPIClient::V2::DORADeploymentRequestAttributes.new({
+      finished_at: 1693491984000000000,
+      git: DatadogAPIClient::V2::DORAGitInfo.new({
+        commit_sha: "66adc9350f2cc9b250b69abddab733dd55e1a588",
+        repository_url: "https://github.com/organization/example-repository",
+      }),
+      service: "shopist",
+      started_at: 1693491974000000000,
+      version: "v1.12.07",
+    }),
+  }),
+})
+p api_instance.create_dora_deployment(body)

data/examples/v2/dora-metrics/CreateDORAIncident.rb

@@ -0,0 +1,25 @@
+# Send an incident event for DORA Metrics returns "OK" response
+
+require "datadog_api_client"
+DatadogAPIClient.configure do |config|
+  config.unstable_operations["v2.create_dora_incident".to_sym] = true
+end
+api_instance = DatadogAPIClient::V2::DORAMetricsAPI.new
+
+body = DatadogAPIClient::V2::DORAIncidentRequest.new({
+  data: DatadogAPIClient::V2::DORAIncidentRequestData.new({
+    attributes: DatadogAPIClient::V2::DORAIncidentRequestAttributes.new({
+      finished_at: 1693491984000000000,
+      git: DatadogAPIClient::V2::DORAGitInfo.new({
+        commit_sha: "66adc9350f2cc9b250b69abddab733dd55e1a588",
+        repository_url: "https://github.com/organization/example-repository",
+      }),
+      name: "Webserver is down failing all requests",
+      service: "shopist",
+      severity: "High",
+      started_at: 1693491974000000000,
+      version: "v1.12.07",
+    }),
+  }),
+})
+p api_instance.create_dora_incident(body)

data/examples/v2/downtimes/ListMonitorDowntimes_3316718253.rb

@@ -0,0 +1,5 @@
+# Get active downtimes for a monitor returns "OK" response with pagination
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::DowntimesAPI.new
+api_instance.list_monitor_downtimes_with_pagination(9223372036854775807) { |item| puts item }

data/examples/v2/events/ListEvents.rb

@@ -1,8 +1,5 @@
 # Get a list of events returns "OK" response
 
 require "datadog_api_client"
-DatadogAPIClient.configure do |config|
-  config.unstable_operations["v2.list_events".to_sym] = true
-end
 api_instance = DatadogAPIClient::V2::EventsAPI.new
 p api_instance.list_events()

data/examples/v2/events/ListEvents_1527584014.rb

@@ -1,9 +1,6 @@
 # Get a list of events returns "OK" response with pagination
 
 require "datadog_api_client"
-DatadogAPIClient.configure do |config|
-  config.unstable_operations["v2.list_events".to_sym] = true
-end
 api_instance = DatadogAPIClient::V2::EventsAPI.new
 opts = {
   filter_from: "now-15m",

data/examples/v2/events/ListEvents_2663715109.rb

@@ -1,9 +1,6 @@
 # Get a quick list of events returns "OK" response
 
 require "datadog_api_client"
-DatadogAPIClient.configure do |config|
-  config.unstable_operations["v2.list_events".to_sym] = true
-end
 api_instance = DatadogAPIClient::V2::EventsAPI.new
 opts = {
   filter_query: "datadog-agent",

data/examples/v2/events/SearchEvents.rb

@@ -1,9 +1,6 @@
 # Search events returns "OK" response
 
 require "datadog_api_client"
-DatadogAPIClient.configure do |config|
-  config.unstable_operations["v2.search_events".to_sym] = true
-end
 api_instance = DatadogAPIClient::V2::EventsAPI.new
 
 body = DatadogAPIClient::V2::EventsListRequest.new({

data/examples/v2/events/SearchEvents_3856995058.rb

@@ -1,9 +1,6 @@
 # Search events returns "OK" response with pagination
 
 require "datadog_api_client"
-DatadogAPIClient.configure do |config|
-  config.unstable_operations["v2.search_events".to_sym] = true
-end
 api_instance = DatadogAPIClient::V2::EventsAPI.new
 
 body = DatadogAPIClient::V2::EventsListRequest.new({

data/examples/v2/gcp-integration/CreateGCPSTSAccount_130557025.rb

@@ -0,0 +1,16 @@
+# Create a new entry for your service account with resource collection enabled returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::GCPIntegrationAPI.new
+
+body = DatadogAPIClient::V2::GCPSTSServiceAccountCreateRequest.new({
+  data: DatadogAPIClient::V2::GCPSTSServiceAccountData.new({
+    attributes: DatadogAPIClient::V2::GCPSTSServiceAccountAttributes.new({
+      resource_collection_enabled: true,
+      client_email: "252bf553ef04b351@test-project.iam.gserviceaccount.com",
+      host_filters: [],
+    }),
+    type: DatadogAPIClient::V2::GCPServiceAccountType::GCP_SERVICE_ACCOUNT,
+  }),
+})
+p api_instance.create_gcpsts_account(body)

data/examples/v2/gcp-integration/CreateGCPSTSAccount_2597004741.rb

@@ -0,0 +1,16 @@
+# Create a new entry for your service account with security command center enabled returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::GCPIntegrationAPI.new
+
+body = DatadogAPIClient::V2::GCPSTSServiceAccountCreateRequest.new({
+  data: DatadogAPIClient::V2::GCPSTSServiceAccountData.new({
+    attributes: DatadogAPIClient::V2::GCPSTSServiceAccountAttributes.new({
+      is_security_command_center_enabled: true,
+      client_email: "252bf553ef04b351@test-project.iam.gserviceaccount.com",
+      host_filters: [],
+    }),
+    type: DatadogAPIClient::V2::GCPServiceAccountType::GCP_SERVICE_ACCOUNT,
+  }),
+})
+p api_instance.create_gcpsts_account(body)

data/examples/v2/gcp-integration/CreateGCPSTSAccount_4235664992.rb

@@ -0,0 +1,17 @@
+# Create a new entry for your service account with cspm enabled returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::GCPIntegrationAPI.new
+
+body = DatadogAPIClient::V2::GCPSTSServiceAccountCreateRequest.new({
+  data: DatadogAPIClient::V2::GCPSTSServiceAccountData.new({
+    attributes: DatadogAPIClient::V2::GCPSTSServiceAccountAttributes.new({
+      is_cspm_enabled: true,
+      resource_collection_enabled: true,
+      client_email: "252bf553ef04b351@test-project.iam.gserviceaccount.com",
+      host_filters: [],
+    }),
+    type: DatadogAPIClient::V2::GCPServiceAccountType::GCP_SERVICE_ACCOUNT,
+  }),
+})
+p api_instance.create_gcpsts_account(body)

data/examples/v2/gcp-integration/UpdateGCPSTSAccount_3205636354.rb

@@ -0,0 +1,19 @@
+# Update STS Service Account returns "OK" response with enable resource collection turned on
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::GCPIntegrationAPI.new
+
+# there is a valid "gcp_sts_account" in the system
+GCP_STS_ACCOUNT_DATA_ID = ENV["GCP_STS_ACCOUNT_DATA_ID"]
+
+body = DatadogAPIClient::V2::GCPSTSServiceAccountUpdateRequest.new({
+  data: DatadogAPIClient::V2::GCPSTSServiceAccountUpdateRequestData.new({
+    attributes: DatadogAPIClient::V2::GCPSTSServiceAccountAttributes.new({
+      client_email: "252bf553ef04b351@example.com",
+      resource_collection_enabled: true,
+    }),
+    id: GCP_STS_ACCOUNT_DATA_ID,
+    type: DatadogAPIClient::V2::GCPServiceAccountType::GCP_SERVICE_ACCOUNT,
+  }),
+})
+p api_instance.update_gcpsts_account(GCP_STS_ACCOUNT_DATA_ID, body)

data/examples/v2/okta-integration/CreateOktaAccount.rb

@@ -0,0 +1,19 @@
+# Add Okta account returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::OktaIntegrationAPI.new
+
+body = DatadogAPIClient::V2::OktaAccountRequest.new({
+  data: DatadogAPIClient::V2::OktaAccount.new({
+    attributes: DatadogAPIClient::V2::OktaAccountAttributes.new({
+      auth_method: "oauth",
+      domain: "https://example.okta.com/",
+      name: "Okta_Prod",
+      client_id: "client_id",
+      client_secret: "client_secret",
+    }),
+    id: "f749daaf-682e-4208-a38d-c9b43162c609",
+    type: DatadogAPIClient::V2::OktaAccountType::OKTA_ACCOUNTS,
+  }),
+})
+p api_instance.create_okta_account(body)

data/examples/v2/okta-integration/DeleteOktaAccount.rb

@@ -0,0 +1,5 @@
+# Delete Okta account returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::OktaIntegrationAPI.new
+api_instance.delete_okta_account("account_id")

data/examples/v2/okta-integration/GetOktaAccount.rb

@@ -0,0 +1,8 @@
+# Get Okta account returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::OktaIntegrationAPI.new
+
+# there is a valid "okta_account" in the system
+OKTA_ACCOUNT_DATA_ID = ENV["OKTA_ACCOUNT_DATA_ID"]
+p api_instance.get_okta_account(OKTA_ACCOUNT_DATA_ID)

data/examples/v2/okta-integration/ListOktaAccounts.rb

@@ -0,0 +1,5 @@
+# List Okta accounts returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::OktaIntegrationAPI.new
+p api_instance.list_okta_accounts()

data/examples/v2/okta-integration/UpdateOktaAccount.rb

@@ -0,0 +1,20 @@
+# Update Okta account returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::OktaIntegrationAPI.new
+
+# there is a valid "okta_account" in the system
+OKTA_ACCOUNT_DATA_ID = ENV["OKTA_ACCOUNT_DATA_ID"]
+
+body = DatadogAPIClient::V2::OktaAccountUpdateRequest.new({
+  data: DatadogAPIClient::V2::OktaAccountUpdateRequestData.new({
+    attributes: DatadogAPIClient::V2::OktaAccountUpdateRequestAttributes.new({
+      auth_method: "oauth",
+      domain: "https://example.okta.com/",
+      client_id: "client_id",
+      client_secret: "client_secret",
+    }),
+    type: DatadogAPIClient::V2::OktaAccountType::OKTA_ACCOUNTS,
+  }),
+})
+p api_instance.update_okta_account(OKTA_ACCOUNT_DATA_ID, body)

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

@@ -0,0 +1,46 @@
+# Create a detection rule with detection method 'third_party' returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::SecurityMonitoringAPI.new
+
+body = DatadogAPIClient::V2::SecurityMonitoringStandardRuleCreatePayload.new({
+  name: "Example-Security-Monitoring",
+  type: DatadogAPIClient::V2::SecurityMonitoringRuleTypeCreate::LOG_DETECTION,
+  is_enabled: true,
+  third_party_cases: [
+    DatadogAPIClient::V2::SecurityMonitoringThirdPartyRuleCaseCreate.new({
+      query: "status:error",
+      name: "high",
+      status: DatadogAPIClient::V2::SecurityMonitoringRuleSeverity::HIGH,
+    }),
+    DatadogAPIClient::V2::SecurityMonitoringThirdPartyRuleCaseCreate.new({
+      query: "status:info",
+      name: "low",
+      status: DatadogAPIClient::V2::SecurityMonitoringRuleSeverity::LOW,
+    }),
+  ],
+  queries: [],
+  cases: [],
+  message: "This is a third party rule",
+  options: DatadogAPIClient::V2::SecurityMonitoringRuleOptions.new({
+    detection_method: DatadogAPIClient::V2::SecurityMonitoringRuleDetectionMethod::THIRD_PARTY,
+    keep_alive: DatadogAPIClient::V2::SecurityMonitoringRuleKeepAlive::ZERO_MINUTES,
+    max_signal_duration: DatadogAPIClient::V2::SecurityMonitoringRuleMaxSignalDuration::ZERO_MINUTES,
+    third_party_rule_options: DatadogAPIClient::V2::SecurityMonitoringRuleThirdPartyOptions.new({
+      default_status: DatadogAPIClient::V2::SecurityMonitoringRuleSeverity::INFO,
+      root_queries: [
+        DatadogAPIClient::V2::SecurityMonitoringThirdPartyRootQuery.new({
+          query: "source:guardduty @details.alertType:*EC2*",
+          group_by_fields: [
+            "instance-id",
+          ],
+        }),
+        DatadogAPIClient::V2::SecurityMonitoringThirdPartyRootQuery.new({
+          query: "source:guardduty",
+          group_by_fields: [],
+        }),
+      ],
+    }),
+  }),
+})
+p api_instance.create_security_monitoring_rule(body)

data/examples/v2/sensitive-data-scanner/CreateScanningRule.rb

@@ -26,6 +26,13 @@ body = DatadogAPIClient::V2::SensitiveDataScannerRuleCreateRequest.new({
         "sensitive_data:true",
       ],
       is_enabled: true,
+      priority: 1,
+      included_keyword_configuration: DatadogAPIClient::V2::SensitiveDataScannerIncludedKeywordConfiguration.new({
+        keywords: [
+          "credit card",
+        ],
+        character_count: 35,
+      }),
     }),
     relationships: DatadogAPIClient::V2::SensitiveDataScannerRuleRelationships.new({
       group: DatadogAPIClient::V2::SensitiveDataScannerGroupData.new({

data/examples/v2/sensitive-data-scanner/UpdateScanningRule.rb

@@ -6,9 +6,6 @@ api_instance = DatadogAPIClient::V2::SensitiveDataScannerAPI.new
 # the "scanning_group" has a "scanning_rule"
 RULE_DATA_ID = ENV["RULE_DATA_ID"]
 
-# there is a valid "scanning_group" in the system
-GROUP_DATA_ID = ENV["GROUP_DATA_ID"]
-
 body = DatadogAPIClient::V2::SensitiveDataScannerRuleUpdateRequest.new({
   meta: DatadogAPIClient::V2::SensitiveDataScannerMetaVersionOnly.new({}),
   data: DatadogAPIClient::V2::SensitiveDataScannerRuleUpdate.new({
@@ -24,13 +21,13 @@ body = DatadogAPIClient::V2::SensitiveDataScannerRuleUpdateRequest.new({
         "sensitive_data:true",
       ],
       is_enabled: true,
-    }),
-    relationships: DatadogAPIClient::V2::SensitiveDataScannerRuleRelationships.new({
-      group: DatadogAPIClient::V2::SensitiveDataScannerGroupData.new({
-        data: DatadogAPIClient::V2::SensitiveDataScannerGroup.new({
-          type: DatadogAPIClient::V2::SensitiveDataScannerGroupType::SENSITIVE_DATA_SCANNER_GROUP,
-          id: GROUP_DATA_ID,
-        }),
+      priority: 5,
+      included_keyword_configuration: DatadogAPIClient::V2::SensitiveDataScannerIncludedKeywordConfiguration.new({
+        keywords: [
+          "credit card",
+          "cc",
+        ],
+        character_count: 35,
       }),
     }),
   }),

data/examples/v2/teams/CreateTeamMembership.rb

@@ -9,6 +9,12 @@ body = DatadogAPIClient::V2::UserTeamRequest.new({
       role: DatadogAPIClient::V2::UserTeamRole::ADMIN,
     }),
     relationships: DatadogAPIClient::V2::UserTeamRelationships.new({
+      team: DatadogAPIClient::V2::RelationshipToUserTeamTeam.new({
+        data: DatadogAPIClient::V2::RelationshipToUserTeamTeamData.new({
+          id: "d7e15d9d-d346-43da-81d8-3d9e71d9a5e9",
+          type: DatadogAPIClient::V2::UserTeamTeamType::TEAM,
+        }),
+      }),
       user: DatadogAPIClient::V2::RelationshipToUserTeamUser.new({
         data: DatadogAPIClient::V2::RelationshipToUserTeamUserData.new({
           id: "b8626d7e-cedd-11eb-abf5-da7ad0900001",

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

@@ -0,0 +1,8 @@
+# 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/GetMonthlyCostAttribution.rb

@@ -0,0 +1,8 @@
+# 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
+p api_instance.get_monthly_cost_attribution((Time.now + -5 * 86400), (Time.now + -3 * 86400), "infra_host_total_cost")

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

@@ -0,0 +1,8 @@
+# Get projected cost across your account returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::UsageMeteringAPI.new
+opts = {
+  view: "sub-org",
+}
+p api_instance.get_projected_cost(opts)

data/lib/datadog_api_client/configuration.rb

@@ -189,11 +189,10 @@ module DatadogAPIClient
       @http_proxypass = nil
       @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
       @unstable_operations = {
-            "v2.create_ci_app_pipeline_event": false,
-            "v2.list_container_images": false,
-            "v2.list_containers": false,
-            "v2.list_events": false,
-            "v2.search_events": false,
+            "v2.get_active_billing_dimensions": false,
+            "v2.get_monthly_cost_attribution": false,
+            "v2.create_dora_deployment": false,
+            "v2.create_dora_incident": false,
             "v2.create_incident": false,
             "v2.create_incident_integration": false,
             "v2.create_incident_todo": false,