Class: SwaggerClient::VulnerabilityExceptionApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ VulnerabilityExceptionApi

Returns a new instance of VulnerabilityExceptionApi.



16
17
18
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/vulnerability_exception_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/vulnerability_exception_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#create_vulnerability_exception(opts = {}) ⇒ CreatedReferenceVulnerabilityExceptionIDLink

Exceptions Creates a vulnerability exception.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



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

def create_vulnerability_exception(opts = {})
  data, _status_code, _headers = create_vulnerability_exception_with_http_info(opts)
  data
end

#create_vulnerability_exception_with_http_info(opts = {}) ⇒ Array<(CreatedReferenceVulnerabilityExceptionIDLink, Integer, Hash)>

Exceptions Creates a vulnerability exception.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



34
35
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
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/vulnerability_exception_api.rb', line 34

def create_vulnerability_exception_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VulnerabilityExceptionApi.create_vulnerability_exception ...'
  end
  # resource path
  local_var_path = '/api/3/vulnerability_exceptions'

  # 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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body']) 

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

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:POST, 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: VulnerabilityExceptionApi#create_vulnerability_exception\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_vulnerability_exception(site_idte_id, opts = {}) ⇒ VulnerabilityException

Exception Returns an exception made on a vulnerability.

Parameters:

  • id —

    The identifier of the vulnerability exception.

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

    the optional parameters

Returns:



78
79
80
81
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/vulnerability_exception_api.rb', line 78

def get_vulnerability_exception(site_idte_id, opts = {})
  data, _status_code, _headers = get_vulnerability_exception_with_http_info(site_idte_id, opts)
  data
end

#get_vulnerability_exception_expiration(site_idte_id, opts = {}) ⇒ String

Exception Expiration Get the expiration date for a vulnerability exception.

Parameters:

  • id —

    id

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

    the optional parameters

Returns:

  • (String) 


134
135
136
137
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/vulnerability_exception_api.rb', line 134

def get_vulnerability_exception_expiration(site_idte_id, opts = {})
  data, _status_code, _headers = get_vulnerability_exception_expiration_with_http_info(site_idte_id, opts)
  data
end

#get_vulnerability_exception_expiration_with_http_info(site_idte_id, opts = {}) ⇒ Array<(String, Integer, Hash)>

Exception Expiration Get the expiration date for a vulnerability exception.

Parameters:

  • id —

    id

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/vulnerability_exception_api.rb', line 144

def get_vulnerability_exception_expiration_with_http_info(site_idte_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VulnerabilityExceptionApi.get_vulnerability_exception_expiration ...'
  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 VulnerabilityExceptionApi.get_vulnerability_exception_expiration"
  end
  # resource path
  local_var_path = '/api/3/vulnerability_exceptions/{id}/expires'.sub('{' + 'id' + '}', site_idte_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] || 'String' 

  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: VulnerabilityExceptionApi#get_vulnerability_exception_expiration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_vulnerability_exception_with_http_info(site_idte_id, opts = {}) ⇒ Array<(VulnerabilityException, Integer, Hash)>

Exception Returns an exception made on a vulnerability.

Parameters:

  • id —

    The identifier of the vulnerability exception.

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

    the optional parameters

Returns:

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

    VulnerabilityException data, response status code and response headers



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/vulnerability_exception_api.rb', line 88

def get_vulnerability_exception_with_http_info(site_idte_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VulnerabilityExceptionApi.get_vulnerability_exception ...'
  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 VulnerabilityExceptionApi.get_vulnerability_exception"
  end
  # resource path
  local_var_path = '/api/3/vulnerability_exceptions/{id}'.sub('{' + 'id' + '}', site_idte_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] || 'VulnerabilityException' 

  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: VulnerabilityExceptionApi#get_vulnerability_exception\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_vulnerability_exceptions(opts = {}) ⇒ PageOfVulnerabilityException

Exceptions Returns all exceptions defined on vulnerabilities.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The index of the page (zero-based) to retrieve. (default to 0)

  • :size (Integer) —

    The number of records per page to retrieve. (default to 10)

  • :sort (Array<String>) —

    The criteria to sort the records by, in the format: &#x60;property&#x60;. The default sort order is ascending. Multiple sort criteria can be specified using multiple sort query parameters.

Returns:



192
193
194
195
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/vulnerability_exception_api.rb', line 192

def get_vulnerability_exceptions(opts = {})
  data, _status_code, _headers = get_vulnerability_exceptions_with_http_info(opts)
  data
end

#get_vulnerability_exceptions_with_http_info(opts = {}) ⇒ Array<(PageOfVulnerabilityException, Integer, Hash)>

Exceptions Returns all exceptions defined on vulnerabilities.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The index of the page (zero-based) to retrieve.

  • :size (Integer) —

    The number of records per page to retrieve.

  • :sort (Array<String>) —

    The criteria to sort the records by, in the format: &#x60;property&#x60;. The default sort order is ascending. Multiple sort criteria can be specified using multiple sort query parameters.

Returns:



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/vulnerability_exception_api.rb', line 204

def get_vulnerability_exceptions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VulnerabilityExceptionApi.get_vulnerability_exceptions ...'
  end
  # resource path
  local_var_path = '/api/3/vulnerability_exceptions'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'sort'] = @api_client.build_collection_param(opts[:'sort'], :multi) if !opts[:'sort'].nil?

  # 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] || 'PageOfVulnerabilityException' 

  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: VulnerabilityExceptionApi#get_vulnerability_exceptions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#remove_vulnerability_exception(site_idte_id, opts = {}) ⇒ Links

Exception Removes an exception made on a vulnerability.

Parameters:

  • id —

    id

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

    the optional parameters

Returns:



249
250
251
252
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/vulnerability_exception_api.rb', line 249

def remove_vulnerability_exception(site_idte_id, opts = {})
  data, _status_code, _headers = remove_vulnerability_exception_with_http_info(site_idte_id, opts)
  data
end

#remove_vulnerability_exception_with_http_info(site_idte_id, opts = {}) ⇒ Array<(Links, Integer, Hash)>

Exception Removes an exception made on a vulnerability.

Parameters:

  • id —

    id

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

    the optional parameters

Returns:

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

    Links data, response status code and response headers



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/vulnerability_exception_api.rb', line 259

def remove_vulnerability_exception_with_http_info(site_idte_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VulnerabilityExceptionApi.remove_vulnerability_exception ...'
  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 VulnerabilityExceptionApi.remove_vulnerability_exception"
  end
  # resource path
  local_var_path = '/api/3/vulnerability_exceptions/{id}'.sub('{' + 'id' + '}', site_idte_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] || 'Links' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:DELETE, 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: VulnerabilityExceptionApi#remove_vulnerability_exception\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_vulnerability_exception_expiration(body, site_idte_id, opts = {}) ⇒ Links

Exception Expiration Set the expiration date for a vulnerability exception. This must be a valid date in the future.

Parameters:

  • body —

    param1

  • id —

    id

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

    the optional parameters

Returns:



306
307
308
309
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/vulnerability_exception_api.rb', line 306

def update_vulnerability_exception_expiration(body, site_idte_id, opts = {})
  data, _status_code, _headers = update_vulnerability_exception_expiration_with_http_info(body, site_idte_id, opts)
  data
end

#update_vulnerability_exception_expiration_with_http_info(body, site_idte_id, opts = {}) ⇒ Array<(Links, Integer, Hash)>

Exception Expiration Set the expiration date for a vulnerability exception. This must be a valid date in the future.

Parameters:

  • body —

    param1

  • id —

    id

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

    the optional parameters

Returns:

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

    Links data, response status code and response headers



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/vulnerability_exception_api.rb', line 317

def update_vulnerability_exception_expiration_with_http_info(body, site_idte_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VulnerabilityExceptionApi.update_vulnerability_exception_expiration ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling VulnerabilityExceptionApi.update_vulnerability_exception_expiration"
  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 VulnerabilityExceptionApi.update_vulnerability_exception_expiration"
  end
  # resource path
  local_var_path = '/api/3/vulnerability_exceptions/{id}/expires'.sub('{' + 'id' + '}', site_idte_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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

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

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:PUT, 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: VulnerabilityExceptionApi#update_vulnerability_exception_expiration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_vulnerability_exception_status(site_idte_id, status, opts = {}) ⇒ Links

Exception Status Update the status of the vulnerability exception. The status can be one of: ‘"recall"`, `"approve"`, or `"reject"`.

Parameters:

  • id —

    id

  • status —

    Exception Status

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

    the optional parameters

Options Hash (opts):

  • :body (String) —

    param2

Returns:



371
372
373
374
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/vulnerability_exception_api.rb', line 371

def update_vulnerability_exception_status(site_idte_id, status, opts = {})
  data, _status_code, _headers = update_vulnerability_exception_status_with_http_info(site_idte_id, status, opts)
  data
end

#update_vulnerability_exception_status_with_http_info(site_idte_id, status, opts = {}) ⇒ Array<(Links, Integer, Hash)>

Exception Status Update the status of the vulnerability exception. The status can be one of: &#x60;&quot;recall&quot;&#x60;, &#x60;&quot;approve&quot;&#x60;, or &#x60;&quot;reject&quot;&#x60;.

Parameters:

  • id —

    id

  • status —

    Exception Status

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

    the optional parameters

Options Hash (opts):

  • :body (String) —

    param2

Returns:

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

    Links data, response status code and response headers



383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/vulnerability_exception_api.rb', line 383

def update_vulnerability_exception_status_with_http_info(site_idte_id, status, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VulnerabilityExceptionApi.update_vulnerability_exception_status ...'
  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 VulnerabilityExceptionApi.update_vulnerability_exception_status"
  end
  # verify the required parameter 'status' is set
  if @api_client.config.client_side_validation && status.nil?
    fail ArgumentError, "Missing the required parameter 'status' when calling VulnerabilityExceptionApi.update_vulnerability_exception_status"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['recall', 'approve', 'reject'].include?(status)
    fail ArgumentError, "invalid value for 'status', must be one of recall, approve, reject"
  end
  # resource path
  local_var_path = '/api/3/vulnerability_exceptions/{id}/{status}'.sub('{' + 'id' + '}', site_idte_id.to_s).sub('{' + 'status' + '}', status.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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body']) 

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

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:POST, 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: VulnerabilityExceptionApi#update_vulnerability_exception_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end