Class: SwaggerClient::RemediationApi

Inherits:
Object
  • Object
show all
Defined in:
lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/remediation_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RemediationApi

Returns a new instance of RemediationApi.



16
17
18
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/remediation_api.rb', line 16

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/remediation_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#get_asset_vulnerability_solutions(site_idte_id, vulnerability_id, opts = {}) ⇒ ResourcesMatchedSolution

Asset Vulnerability Solution Returns the highest-superceding rollup solutions for a vulnerability on an asset. The solution(s) selected will be the most recent and cost-effective means by which the vulnerability can be remediated.

Parameters:

  • id —

    The identifier of the asset.

  • vulnerability_id —

    The identifier of the vulnerability.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



25
26
27
28
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/remediation_api.rb', line 25

def get_asset_vulnerability_solutions(site_idte_id, vulnerability_id, opts = {})
  data, _status_code, _headers = get_asset_vulnerability_solutions_with_http_info(site_idte_id, vulnerability_id, opts)
  data
end

#get_asset_vulnerability_solutions_with_http_info(site_idte_id, vulnerability_id, opts = {}) ⇒ Array<(ResourcesMatchedSolution, Integer, Hash)>

Asset Vulnerability Solution Returns the highest-superceding rollup solutions for a vulnerability on an asset. The solution(s) selected will be the most recent and cost-effective means by which the vulnerability can be remediated.

Parameters:

  • id —

    The identifier of the asset.

  • vulnerability_id —

    The identifier of the vulnerability.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ResourcesMatchedSolution, Integer, Hash)>) —

    ResourcesMatchedSolution data, response status code and response headers



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/remediation_api.rb', line 36

def get_asset_vulnerability_solutions_with_http_info(site_idte_id, vulnerability_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RemediationApi.get_asset_vulnerability_solutions ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && site_idte_id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling RemediationApi.get_asset_vulnerability_solutions"
  end
  # verify the required parameter 'vulnerability_id' is set
  if @api_client.config.client_side_validation && vulnerability_id.nil?
    fail ArgumentError, "Missing the required parameter 'vulnerability_id' when calling RemediationApi.get_asset_vulnerability_solutions"
  end
  # resource path
  local_var_path = '/api/3/assets/{id}/vulnerabilities/{vulnerabilityId}/solution'.sub('{' + 'id' + '}', site_idte_id.to_s).sub('{' + 'vulnerabilityId' + '}', vulnerability_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json;charset=UTF-8'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'ResourcesMatchedSolution' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RemediationApi#get_asset_vulnerability_solutions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end