datadog_api_client 2.9.0 → 2.11.0

data/lib/datadog_api_client/v2/api/security_monitoring_api.rb

@@ -506,6 +506,82 @@ module DatadogAPIClient::V2
       return data, status_code, headers
     end
 
+    # Get a finding.
+    #
+    # @see #get_finding_with_http_info
+    def get_finding(finding_id, opts = {})
+      data, _status_code, _headers = get_finding_with_http_info(finding_id, opts)
+      data
+    end
+
+    # Get a finding.
+    #
+    # Returns a single finding with message and resource configuration.
+    #
+    # @param finding_id [String] The ID of the finding.
+    # @param opts [Hash] the optional parameters
+    # @option opts [Integer] :snapshot_timestamp Return the finding for a given snapshot of time (Unix ms).
+    # @return [Array<(GetFindingResponse, Integer, Hash)>] GetFindingResponse data, response status code and response headers
+    def get_finding_with_http_info(finding_id, opts = {})
+      unstable_enabled = @api_client.config.unstable_operations["v2.get_finding".to_sym]
+      if unstable_enabled
+        @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_finding")
+      else
+        raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_finding"))
+      end
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SecurityMonitoringAPI.get_finding ...'
+      end
+      # verify the required parameter 'finding_id' is set
+      if @api_client.config.client_side_validation && finding_id.nil?
+        fail ArgumentError, "Missing the required parameter 'finding_id' when calling SecurityMonitoringAPI.get_finding"
+      end
+      if @api_client.config.client_side_validation && !opts[:'snapshot_timestamp'].nil? && opts[:'snapshot_timestamp'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"snapshot_timestamp"]" when calling SecurityMonitoringAPI.get_finding, must be greater than or equal to 1.'
+      end
+      # resource path
+      local_var_path = '/api/v2/posture_management/findings/{finding_id}'.sub('{finding_id}', CGI.escape(finding_id.to_s).gsub('%2F', '/'))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'snapshot_timestamp'] = opts[:'snapshot_timestamp'] if !opts[:'snapshot_timestamp'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetFindingResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]
+
+      new_options = opts.merge(
+        :operation => :get_finding,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type,
+        :api_version => "V2"
+      )
+
+      data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SecurityMonitoringAPI#get_finding\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get a security filter.
     #
     # @see #get_security_filter_with_http_info
@@ -704,6 +780,162 @@ module DatadogAPIClient::V2
       return data, status_code, headers
     end
 
+    # List findings.
+    #
+    # @see #list_findings_with_http_info
+    def list_findings(opts = {})
+      data, _status_code, _headers = list_findings_with_http_info(opts)
+      data
+    end
+
+    # List findings.
+    #
+    # Get a list of CSPM findings.
+    #
+    # ### Filtering
+    #
+    # Filters can be applied by appending query parameters to the URL.
+    #
+    #   - Using a single filter: `?filter[attribute_key]=attribute_value`
+    #   - Chaining filters: `?filter[attribute_key]=attribute_value&filter[attribute_key]=attribute_value...`
+    #   - Filtering on tags: `?filter[tags]=tag_key:tag_value&filter[tags]=tag_key_2:tag_value_2`
+    #
+    # Here, `attribute_key` can be any of the filter keys described further below.
+    #
+    # Query parameters of type `integer` support comparison operators (`>`, `>=`, `<`, `<=`). This is particularly useful when filtering by `evaluation_changed_at` or `resource_discovery_timestamp`. For example: `?filter[evaluation_changed_at]=>20123123121`.
+    #
+    # You can also use the negation operator on strings. For example, use `filter[resource_type]=-aws*` to filter for any non-AWS resources.
+    #
+    # The operator must come after the equal sign. For example, to filter with the `>=` operator, add the operator after the equal sign: `filter[evaluation_changed_at]=>=1678809373257`.
+    #
+    # ### Response
+    #
+    # The response includes an array of finding objects, pagination metadata, and a count of items that match the query.
+    #
+    # Each finding object contains the following:
+    #
+    # - The finding ID that can be used in a `GetFinding` request to retrieve the full finding details.
+    # - Core attributes, including status, evaluation, high-level resource details, muted state, and rule details.
+    # - `evaluation_changed_at` and `resource_discovery_date` time stamps.
+    # - An array of associated tags.
+    #
+    #
+    # @param opts [Hash] the optional parameters
+    # @option opts [Integer] :page_limit Limit the number of findings returned. Must be <= 1000.
+    # @option opts [Integer] :snapshot_timestamp Return findings for a given snapshot of time (Unix ms).
+    # @option opts [String] :page_cursor Return the next page of findings pointed to by the cursor.
+    # @option opts [String] :filter_tags Return findings that have these associated tags (repeatable).
+    # @option opts [String] :filter_evaluation_changed_at Return findings that have changed from pass to fail or vice versa on a specified date (Unix ms) or date range (using comparison operators).
+    # @option opts [Boolean] :filter_muted Set to `true` to return findings that are muted. Set to `false` to return unmuted findings.
+    # @option opts [String] :filter_rule_id Return findings for the specified rule ID.
+    # @option opts [String] :filter_rule_name Return findings for the specified rule.
+    # @option opts [String] :filter_resource_type Return only findings for the specified resource type.
+    # @option opts [String] :filter_discovery_timestamp Return findings that were found on a specified date (Unix ms) or date range (using comparison operators).
+    # @option opts [FindingEvaluation] :filter_evaluation Return only `pass` or `fail` findings.
+    # @option opts [FindingStatus] :filter_status Return only findings with the specified status.
+    # @return [Array<(ListFindingsResponse, Integer, Hash)>] ListFindingsResponse data, response status code and response headers
+    def list_findings_with_http_info(opts = {})
+      unstable_enabled = @api_client.config.unstable_operations["v2.list_findings".to_sym]
+      if unstable_enabled
+        @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_findings")
+      else
+        raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_findings"))
+      end
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SecurityMonitoringAPI.list_findings ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'page_limit'].nil? && opts[:'page_limit'] > 1000
+        fail ArgumentError, 'invalid value for "opts[:"page_limit"]" when calling SecurityMonitoringAPI.list_findings, must be smaller than or equal to 1000.'
+      end
+      if @api_client.config.client_side_validation && !opts[:'page_limit'].nil? && opts[:'page_limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page_limit"]" when calling SecurityMonitoringAPI.list_findings, must be greater than or equal to 1.'
+      end
+      if @api_client.config.client_side_validation && !opts[:'snapshot_timestamp'].nil? && opts[:'snapshot_timestamp'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"snapshot_timestamp"]" when calling SecurityMonitoringAPI.list_findings, must be greater than or equal to 1.'
+      end
+      allowable_values = ['pass', 'fail']
+      if @api_client.config.client_side_validation && opts[:'filter_evaluation'] && !allowable_values.include?(opts[:'filter_evaluation'])
+        fail ArgumentError, "invalid value for \"filter_evaluation\", must be one of #{allowable_values}"
+      end
+      allowable_values = ['critical', 'high', 'medium', 'low', 'info']
+      if @api_client.config.client_side_validation && opts[:'filter_status'] && !allowable_values.include?(opts[:'filter_status'])
+        fail ArgumentError, "invalid value for \"filter_status\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/api/v2/posture_management/findings'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page[limit]'] = opts[:'page_limit'] if !opts[:'page_limit'].nil?
+      query_params[:'snapshot_timestamp'] = opts[:'snapshot_timestamp'] if !opts[:'snapshot_timestamp'].nil?
+      query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
+      query_params[:'filter[tags]'] = opts[:'filter_tags'] if !opts[:'filter_tags'].nil?
+      query_params[:'filter[evaluation_changed_at]'] = opts[:'filter_evaluation_changed_at'] if !opts[:'filter_evaluation_changed_at'].nil?
+      query_params[:'filter[muted]'] = opts[:'filter_muted'] if !opts[:'filter_muted'].nil?
+      query_params[:'filter[rule_id]'] = opts[:'filter_rule_id'] if !opts[:'filter_rule_id'].nil?
+      query_params[:'filter[rule_name]'] = opts[:'filter_rule_name'] if !opts[:'filter_rule_name'].nil?
+      query_params[:'filter[resource_type]'] = opts[:'filter_resource_type'] if !opts[:'filter_resource_type'].nil?
+      query_params[:'filter[discovery_timestamp]'] = opts[:'filter_discovery_timestamp'] if !opts[:'filter_discovery_timestamp'].nil?
+      query_params[:'filter[evaluation]'] = opts[:'filter_evaluation'] if !opts[:'filter_evaluation'].nil?
+      query_params[:'filter[status]'] = opts[:'filter_status'] if !opts[:'filter_status'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ListFindingsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]
+
+      new_options = opts.merge(
+        :operation => :list_findings,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type,
+        :api_version => "V2"
+      )
+
+      data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SecurityMonitoringAPI#list_findings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List findings.
+    #
+    # Provide a paginated version of {#list_findings}, returning all items.
+    #
+    # To use it you need to use a block: list_findings_with_pagination { |item| p item }
+    #
+    # @yield [Finding] Paginated items
+    def list_findings_with_pagination(opts = {})
+        api_version = "V2"
+        page_size = @api_client.get_attribute_from_path(opts, "page_limit", 100)
+        @api_client.set_attribute_from_path(api_version, opts, "page_limit", FindingStatus, page_size)
+        while true do
+            response = list_findings(opts)
+            @api_client.get_attribute_from_path(response, "data").each { |item| yield(item) }
+            if @api_client.get_attribute_from_path(response, "data").length < page_size
+              break
+            end
+            @api_client.set_attribute_from_path(api_version, opts, "page_cursor", FindingStatus, @api_client.get_attribute_from_path(response, "meta.page.cursor"))
+        end
+    end
+
     # Get all security filters.
     #
     # @see #list_security_filters_with_http_info

data/lib/datadog_api_client/v2/api/service_definition_api.rb

@@ -70,7 +70,7 @@ module DatadogAPIClient::V2
       return_type = opts[:debug_return_type] || 'ServiceDefinitionCreateResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]
 
       new_options = opts.merge(
         :operation => :create_or_update_service_definitions,
@@ -135,7 +135,7 @@ module DatadogAPIClient::V2
       return_type = opts[:debug_return_type]
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]
 
       new_options = opts.merge(
         :operation => :delete_service_definition,
@@ -169,6 +169,7 @@ module DatadogAPIClient::V2
     #
     # @param service_name [String] The name of the service.
     # @param opts [Hash] the optional parameters
+    # @option opts [ServiceDefinitionSchemaVersions] :schema_version The schema version desired in the response.
     # @return [Array<(ServiceDefinitionGetResponse, Integer, Hash)>] ServiceDefinitionGetResponse data, response status code and response headers
     def get_service_definition_with_http_info(service_name, opts = {})
 
@@ -179,11 +180,16 @@ module DatadogAPIClient::V2
       if @api_client.config.client_side_validation && service_name.nil?
         fail ArgumentError, "Missing the required parameter 'service_name' when calling ServiceDefinitionAPI.get_service_definition"
       end
+      allowable_values = ['v1', 'v2', 'v2.1']
+      if @api_client.config.client_side_validation && opts[:'schema_version'] && !allowable_values.include?(opts[:'schema_version'])
+        fail ArgumentError, "invalid value for \"schema_version\", must be one of #{allowable_values}"
+      end
       # resource path
       local_var_path = '/api/v2/services/definitions/{service_name}'.sub('{service_name}', CGI.escape(service_name.to_s).gsub('%2F', '/'))
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'schema_version'] = opts[:'schema_version'] if !opts[:'schema_version'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -200,7 +206,7 @@ module DatadogAPIClient::V2
       return_type = opts[:debug_return_type] || 'ServiceDefinitionGetResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]
 
       new_options = opts.merge(
         :operation => :get_service_definition,
@@ -233,17 +239,27 @@ module DatadogAPIClient::V2
     # Get a list of all service definitions from the Datadog Service Catalog.
     #
     # @param opts [Hash] the optional parameters
+    # @option opts [Integer] :page_size Size for a given page. The maximum allowed value is 5000.
+    # @option opts [Integer] :page_number Specific page number to return.
+    # @option opts [ServiceDefinitionSchemaVersions] :schema_version The schema version desired in the response.
     # @return [Array<(ServiceDefinitionsListResponse, Integer, Hash)>] ServiceDefinitionsListResponse data, response status code and response headers
     def list_service_definitions_with_http_info(opts = {})
 
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ServiceDefinitionAPI.list_service_definitions ...'
       end
+      allowable_values = ['v1', 'v2', 'v2.1']
+      if @api_client.config.client_side_validation && opts[:'schema_version'] && !allowable_values.include?(opts[:'schema_version'])
+        fail ArgumentError, "invalid value for \"schema_version\", must be one of #{allowable_values}"
+      end
       # resource path
       local_var_path = '/api/v2/services/definitions'
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+      query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
+      query_params[:'schema_version'] = opts[:'schema_version'] if !opts[:'schema_version'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -260,7 +276,7 @@ module DatadogAPIClient::V2
       return_type = opts[:debug_return_type] || 'ServiceDefinitionsListResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]
 
       new_options = opts.merge(
         :operation => :list_service_definitions,
@@ -279,5 +295,26 @@ module DatadogAPIClient::V2
       end
       return data, status_code, headers
     end
+
+    # Get all service definitions.
+    #
+    # Provide a paginated version of {#list_service_definitions}, returning all items.
+    #
+    # To use it you need to use a block: list_service_definitions_with_pagination { |item| p item }
+    #
+    # @yield [ServiceDefinitionData] Paginated items
+    def list_service_definitions_with_pagination(opts = {})
+        api_version = "V2"
+        page_size = @api_client.get_attribute_from_path(opts, "page_size", 10)
+        @api_client.set_attribute_from_path(api_version, opts, "page_size", ServiceDefinitionSchemaVersions, page_size)
+        while true do
+            response = list_service_definitions(opts)
+            @api_client.get_attribute_from_path(response, "data").each { |item| yield(item) }
+            if @api_client.get_attribute_from_path(response, "data").length < page_size
+              break
+            end
+            @api_client.set_attribute_from_path(api_version, opts, "page_number", ServiceDefinitionSchemaVersions, @api_client.get_attribute_from_path(opts, "page_number", 0) + page_size)
+        end
+    end
   end
 end