dogapi 1.37.1 → 1.42.0

data/lib/dogapi/v1/embed.rb

@@ -1,3 +1,7 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the BSD-3-Clause License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2011-Present Datadog, Inc.
+
 require 'dogapi'
 
 module Dogapi

data/lib/dogapi/v1/event.rb

@@ -1,3 +1,7 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the BSD-3-Clause License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2011-Present Datadog, Inc.
+
 require 'dogapi'
 
 module Dogapi

data/lib/dogapi/v1/gcp_integration.rb

@@ -0,0 +1,76 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the BSD-3-Clause License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2011-Present Datadog, Inc.
+
+require 'dogapi'
+
+module Dogapi
+  class V1 # for namespacing
+
+    # GcpIntegrationService for user interaction with gcp configs.
+    class GcpIntegrationService < Dogapi::APIService
+
+      API_VERSION = 'v1'
+
+      # Retrieve gcp integration information
+      def gcp_integration_list
+        request(Net::HTTP::Get, "/api/#{API_VERSION}/integration/gcp", nil, nil, false)
+      end
+
+      # Delete an gcp integration
+      # :config => Hash: integration config.
+      # config = {
+      #   :project_id => 'datadog-sandbox',
+      #   :client_email => 'email@example.com'
+      # }
+      #
+      # dog = Dogapi::Client.new(api_key, app_key)
+      #
+      # puts dog.gcp_integration_delete(config)
+      def gcp_integration_delete(config)
+        request(Net::HTTP::Delete, "/api/#{API_VERSION}/integration/gcp", nil, config, true)
+      end
+
+      # Create an gcp integration
+      # :config => Hash: integration config.
+      # config = {
+      #   :type => 'service_account',
+      #   :project_id => '<PROJECT_ID>',
+      #   :private_key_id => '<PRIVATE_KEY_ID>',
+      #   :private_key => '<PRIVATE_KEY>',
+      #   :client_email => '<CLIENT_EMAIL>',
+      #   :client_id => '<CLIENT_ID>',
+      #   :auth_uri => '<AUTH_URI>',
+      #   :token_uri => '<TOKEN_URI>',
+      #   :auth_provider_x509_cert_url => '<AUTH_PROVIDER_X509_CERT_URL>',
+      #   :client_x509_cert_url => '<CLIENT_X509_CERT_URL>',
+      #   :host_filters => '<KEY>:<VALUE>,<KEY>:<VALUE>,'
+      # }
+      #
+      # dog = Dogapi::Client.new(api_key, app_key)
+      #
+      # puts dog.gcp_integration_create(config)
+      def gcp_integration_create(config)
+        request(Net::HTTP::Post, "/api/#{API_VERSION}/integration/gcp", nil, config, true)
+      end
+
+      # Update a configured gcp account.
+      # :config => Hash: integration config.
+      # config = {
+      #   :project_id => '<PROJECT_ID>',
+      #   :client_email => '<CLIENT_EMAIL>',
+      #   :host_filters => '<KEY>:<VALUE>,<KEY>:<VALUE>,'
+      #   :automute => true # takes a boolean and toggles GCE automuting
+      # }
+      #
+      # dog = Dogapi::Client.new(api_key, app_key)
+      #
+      # puts dog.gcp_integration_update(config)
+      def gcp_integration_update(config)
+        request(Net::HTTP::Put, "/api/#{API_VERSION}/integration/gcp", nil, config, true)
+      end
+
+    end
+
+  end
+end

data/lib/dogapi/v1/hosts.rb

@@ -1,3 +1,7 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the BSD-3-Clause License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2011-Present Datadog, Inc.
+
 require 'dogapi'
 
 module Dogapi

data/lib/dogapi/v1/integration.rb

@@ -1,3 +1,7 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the BSD-3-Clause License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2011-Present Datadog, Inc.
+
 require 'dogapi'
 
 module Dogapi

data/lib/dogapi/v1/metadata.rb

@@ -1,3 +1,7 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the BSD-3-Clause License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2011-Present Datadog, Inc.
+
 require 'dogapi'
 
 module Dogapi

data/lib/dogapi/v1/metric.rb

@@ -1,3 +1,7 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the BSD-3-Clause License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2011-Present Datadog, Inc.
+
 require 'dogapi'
 
 module Dogapi

data/lib/dogapi/v1/monitor.rb

@@ -1,10 +1,12 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the BSD-3-Clause License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2011-Present Datadog, Inc.
+
 require 'dogapi'
 
 module Dogapi
   class V1 # for namespacing
-
     class MonitorService < Dogapi::APIService
-
       API_VERSION = 'v1'
 
       def monitor(type, query, options = {})
@@ -42,8 +44,19 @@ module Dogapi
         request(Net::HTTP::Get, "/api/#{API_VERSION}/monitor/#{monitor_id}", extra_params, nil, false)
       end
 
-      def delete_monitor(monitor_id)
-        request(Net::HTTP::Delete, "/api/#{API_VERSION}/monitor/#{monitor_id}", nil, nil, false)
+      def can_delete_monitors(monitor_ids)
+        extra_params =
+          if monitor_ids.respond_to?(:join)
+            { "monitor_ids" => monitor_ids.join(",") }
+          else
+            { "monitor_ids" => monitor_ids }
+          end
+
+        request(Net::HTTP::Get, "/api/#{API_VERSION}/monitor/can_delete", extra_params, nil, false)
+      end
+
+      def delete_monitor(monitor_id, options = {})
+        request(Net::HTTP::Delete, "/api/#{API_VERSION}/monitor/#{monitor_id}", options, nil, false)
       end
 
       def get_all_monitors(options = {})
@@ -122,8 +135,8 @@ module Dogapi
         request(Net::HTTP::Put, "/api/#{API_VERSION}/downtime/#{downtime_id}", nil, options, true)
       end
 
-      def get_downtime(downtime_id)
-        request(Net::HTTP::Get, "/api/#{API_VERSION}/downtime/#{downtime_id}", nil, nil, false)
+      def get_downtime(downtime_id, options = {})
+        request(Net::HTTP::Get, "/api/#{API_VERSION}/downtime/#{downtime_id}", options, nil, false)
       end
 
       def cancel_downtime(downtime_id)
@@ -131,7 +144,7 @@ module Dogapi
       end
 
       def cancel_downtime_by_scope(scope)
-        request(Net::HTTP::Post, "/api/#{API_VERSION}/downtime/cancel/by_scope", nil, { 'scope' => scope }, false)
+        request(Net::HTTP::Post, "/api/#{API_VERSION}/downtime/cancel/by_scope", nil, { 'scope' => scope }, true)
       end
 
       def get_all_downtimes(options = {})

data/lib/dogapi/v1/screenboard.rb

@@ -1,3 +1,7 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the BSD-3-Clause License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2011-Present Datadog, Inc.
+
 require 'dogapi'
 
 module Dogapi

data/lib/dogapi/v1/search.rb

@@ -1,3 +1,7 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the BSD-3-Clause License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2011-Present Datadog, Inc.
+
 require 'dogapi'
 
 module Dogapi

data/lib/dogapi/v1/service_check.rb

@@ -1,3 +1,7 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the BSD-3-Clause License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2011-Present Datadog, Inc.
+
 require 'dogapi'
 
 module Dogapi

data/lib/dogapi/v1/service_level_objective.rb

@@ -0,0 +1,113 @@
+require 'dogapi'
+
+module Dogapi
+  class V1 # for namespacing
+
+    # Implements Service Level Objectives endpoints
+    class ServiceLevelObjectiveService < Dogapi::APIService
+
+      API_VERSION = 'v1'
+
+      def create_service_level_objective(type, slo_name, thresholds, options = {})
+        body = {
+          type: type,
+          name: slo_name,
+          thresholds: thresholds
+        }
+
+        symbolized_options = Dogapi.symbolized_access(options)
+        if type.to_s == 'metric'
+          body[:query] = {
+            numerator: symbolized_options[:numerator],
+            denominator: symbolized_options[:denominator]
+          }
+        else
+          body[:monitor_search] = symbolized_options[:monitor_search] if symbolized_options[:monitor_search]
+          body[:monitor_ids] = symbolized_options[:monitor_ids] if symbolized_options[:monitor_ids]
+          body[:groups] = symbolized_options[:groups] if symbolized_options[:groups]
+        end
+        body[:tags] = symbolized_options[:tags] if symbolized_options[:tags]
+        body[:description] = symbolized_options[:description] if symbolized_options[:description]
+
+        request(Net::HTTP::Post, "/api/#{API_VERSION}/slo", nil, body, true)
+      end
+
+      def update_service_level_objective(slo_id, type, options = {})
+        body = {
+          type: type
+        }
+
+        symbolized_options = Dogapi.symbolized_access(options)
+        if type == 'metric'
+          if symbolized_options[:numerator] && symbolized_options[:denominator]
+            body[:query] = {
+              numerator: symbolized_options[:numerator],
+              denominator: symbolized_options[:denominator]
+            }
+          end
+        else
+          body[:monitor_search] = symbolized_options[:monitor_search] if symbolized_options[:monitor_search]
+          body[:monitor_ids] = symbolized_options[:monitor_ids] if symbolized_options[:monitor_ids]
+          body[:groups] = symbolized_options[:groups] if symbolized_options[:groups]
+        end
+        [:name, :thresholds, :tags, :description].each do |a|
+          body[a] = symbolized_options[a] if symbolized_options[a]
+        end
+
+        request(Net::HTTP::Put, "/api/#{API_VERSION}/slo/#{slo_id}", nil, body, true)
+      end
+
+      def get_service_level_objective(slo_id)
+        request(Net::HTTP::Get, "/api/#{API_VERSION}/slo/#{slo_id}", nil, nil, false)
+      end
+
+      def search_service_level_objective(slo_ids, query, offset, limit)
+        params = {}
+        params[:offset] = offset unless offset.nil?
+        params[:limit] = limit unless limit.nil?
+        if !slo_ids.nil?
+          params[:ids] = slo_ids.join(',')
+        else
+          params[:query] = query
+        end
+
+        request(Net::HTTP::Get, "/api/#{API_VERSION}/slo/", params, nil, false)
+      end
+
+      def delete_service_level_objective(slo_id)
+        request(Net::HTTP::Delete, "/api/#{API_VERSION}/slo/#{slo_id}", nil, nil, false)
+      end
+
+      def delete_many_service_level_objective(slo_ids)
+        body = {
+          ids: slo_ids
+        }
+        request(Net::HTTP::Delete, "/api/#{API_VERSION}/slo/", nil, body, true)
+      end
+
+      def delete_timeframes_service_level_objective(ops)
+        # ops is a hash of slo_id: [<timeframe>] to delete
+        request(Net::HTTP::Post, "/api/#{API_VERSION}/slo/bulk_delete", nil, ops, true)
+      end
+
+      def get_service_level_objective_history(slo_id, from_ts, to_ts)
+        params = {
+          from_ts: from_ts,
+          to_ts: to_ts
+        }
+        request(Net::HTTP::Get, "/api/#{API_VERSION}/slo/#{slo_id}/history", params, nil, false)
+      end
+
+      def can_delete_service_level_objective(slo_ids)
+        params = {}
+        params[:ids] = if slo_ids.is_a? Array
+                         slo_ids.join(',')
+                       else
+                         slo_ids
+                       end
+        request(Net::HTTP::Get, "/api/#{API_VERSION}/slo/can_delete", params, nil, false)
+      end
+
+    end
+  end
+end

data/lib/dogapi/v1/snapshot.rb

@@ -1,3 +1,7 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the BSD-3-Clause License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2011-Present Datadog, Inc.
+
 require 'dogapi'
 
 module Dogapi

data/lib/dogapi/v1/synthetics.rb

@@ -0,0 +1,80 @@
+require 'dogapi'
+
+module Dogapi
+  class V1 # for namespacing
+    # SyntheticsService is the class responsible for dealing with the synthetics
+    class SyntheticsService < Dogapi::APIService
+
+      API_VERSION = 'v1'
+
+      # Create a synthetics test: POST /v1/synthetics/tests/
+      def create_synthetics_test(type, config, options = {})
+        body = {
+          'type' => type,
+          'config' => config
+        }.merge(options)
+
+        request(Net::HTTP::Post, "/api/#{API_VERSION}/synthetics/tests", nil, body, true)
+      end
+
+      # Edit a synthetics test: PUT /v1/synthetics/tests/<SYNTHETICS_TEST_PUBLIC_ID>
+      def update_synthetics_test(test_id, type, config, options = {})
+        body = {
+          'type' => type,
+          'config' => config
+        }.merge(options)
+
+        request(Net::HTTP::Put, "/api/#{API_VERSION}/synthetics/tests/#{test_id}", nil, body, true)
+      end
+
+      # Delete synthetics tests
+      def delete_synthetics_tests(test_ids)
+        body = {
+          'public_ids' => test_ids
+        }
+        request(Net::HTTP::Post, "/api/#{API_VERSION}/synthetics/tests/delete", nil, body, true)
+      end
+
+      # Start of pause a synthetics test: POST /v1/synthetics/tests/<SYNTHETICS_TEST_PUBLIC_ID>/status
+      def start_pause_synthetics_test(test_id, new_status)
+        body = {
+          'new_status' => new_status
+        }
+        request(Net::HTTP::Put, "/api/#{API_VERSION}/synthetics/tests/#{test_id}/status", nil, body, true)
+      end
+
+      # Get all synthetics tests: GET /v1/synthetics/tests
+      def get_all_synthetics_tests
+        request(Net::HTTP::Get, "/api/#{API_VERSION}/synthetics/tests", nil, nil, false)
+      end
+
+      # Get info on a synthetics test: GET /v1/synthetics/tests/<SYNTHETICS_TEST_PUBLIC_ID>
+      def get_synthetics_test(test_id)
+        request(Net::HTTP::Get, "/api/#{API_VERSION}/synthetics/tests/#{test_id}", nil, nil, false)
+      end
+
+      # Get the most recent results for a synthetics test: GET /v1/synthetics/tests/<SYNTHETICS_TEST_PUBLIC_ID>/results
+      def get_synthetics_results(test_id)
+        request(Net::HTTP::Get, "/api/#{API_VERSION}/synthetics/tests/#{test_id}/results", nil, nil, false)
+      end
+
+      # Get a specific result for a synthetics test:
+      # GET /v1/synthetics/tests/<SYNTHETICS_TEST_PUBLIC_ID>/results/<RESULT_ID>
+      def get_synthetics_result(test_id, result_id)
+        request(Net::HTTP::Get, "/api/#{API_VERSION}/synthetics/tests/#{test_id}/results/#{result_id}", nil, nil, false)
+      end
+
+      # Get devices for browser checks: GET /v1/synthetics/browser/devices
+      def get_synthetics_devices
+        request(Net::HTTP::Get, "/api/#{API_VERSION}/synthetics/browser/devices", nil, nil, false)
+      end
+
+      # Get available locations: GET /v1/synthetics/locations
+      def get_synthetics_locations
+        request(Net::HTTP::Get, "/api/#{API_VERSION}/synthetics/locations", nil, nil, false)
+      end
+
+    end
+
+  end
+end

data/lib/dogapi/v1/tag.rb

@@ -1,3 +1,7 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the BSD-3-Clause License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2011-Present Datadog, Inc.
+
 require 'dogapi'
 
 module Dogapi

data/lib/dogapi/v1/usage.rb

@@ -1,3 +1,7 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the BSD-3-Clause License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2011-Present Datadog, Inc.
+
 require 'dogapi'
 
 module Dogapi

data/lib/dogapi/v1/user.rb

@@ -1,3 +1,7 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the BSD-3-Clause License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2011-Present Datadog, Inc.
+
 require 'dogapi'
 
 module Dogapi

data/lib/dogapi/v2.rb

@@ -1 +1,5 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the BSD-3-Clause License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2011-Present Datadog, Inc.
+
 require 'dogapi/v2/dashboard_list'