Class: SwaggerClient::ScanEngineApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ScanEngineApi

Returns a new instance of ScanEngineApi.



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

def api_client
  @api_client
end

Instance Method Details

#add_scan_engine_pool_scan_engine(site_idte_id, engine_id, opts = {}) ⇒ Links

Engine Pool Engines Add an engine to the engine pool.

Parameters:

  • id —

    The identifier of the engine pool.

  • engine_id —

    The identifier of the scan engine.

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

    the optional parameters

Returns:



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

def add_scan_engine_pool_scan_engine(site_idte_id, engine_id, opts = {})
  data, _status_code, _headers = add_scan_engine_pool_scan_engine_with_http_info(site_idte_id, engine_id, opts)
  data
end

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

Engine Pool Engines Add an engine to the engine pool.

Parameters:

  • id —

    The identifier of the engine pool.

  • engine_id —

    The identifier of the scan engine.

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

    the optional parameters

Returns:

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

    Links 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/scan_engine_api.rb', line 36

def add_scan_engine_pool_scan_engine_with_http_info(site_idte_id, engine_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScanEngineApi.add_scan_engine_pool_scan_engine ...'
  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 ScanEngineApi.add_scan_engine_pool_scan_engine"
  end
  # verify the required parameter 'engine_id' is set
  if @api_client.config.client_side_validation && engine_id.nil?
    fail ArgumentError, "Missing the required parameter 'engine_id' when calling ScanEngineApi.add_scan_engine_pool_scan_engine"
  end
  # resource path
  local_var_path = '/api/3/scan_engine_pools/{id}/engines/{engineId}'.sub('{' + 'id' + '}', site_idte_id.to_s).sub('{' + 'engineId' + '}', engine_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(: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: ScanEngineApi#add_scan_engine_pool_scan_engine\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_scan_engine(opts = {}) ⇒ ReferenceWithEngineIDLink

Scan Engines Creates a new scan engine.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (ScanEngine) —

    The specification of a scan engine.

Returns:



86
87
88
89
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_engine_api.rb', line 86

def create_scan_engine(opts = {})
  data, _status_code, _headers = create_scan_engine_with_http_info(opts)
  data
end

#create_scan_engine_pool(opts = {}) ⇒ CreatedReferenceEngineIDLink

Engine Pools Creates a new engine pool.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (EnginePool) —

    The details for the scan engine to update.

Returns:



140
141
142
143
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_engine_api.rb', line 140

def create_scan_engine_pool(opts = {})
  data, _status_code, _headers = create_scan_engine_pool_with_http_info(opts)
  data
end

#create_scan_engine_pool_with_http_info(opts = {}) ⇒ Array<(CreatedReferenceEngineIDLink, Integer, Hash)>

Engine Pools Creates a new engine pool.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (EnginePool) —

    The details for the scan engine to update.

Returns:



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
185
186
187
188
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_engine_api.rb', line 150

def create_scan_engine_pool_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScanEngineApi.create_scan_engine_pool ...'
  end
  # resource path
  local_var_path = '/api/3/scan_engine_pools'

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

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

#create_scan_engine_with_http_info(opts = {}) ⇒ Array<(ReferenceWithEngineIDLink, Integer, Hash)>

Scan Engines Creates a new scan engine.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (ScanEngine) —

    The specification of a scan engine.

Returns:

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

    ReferenceWithEngineIDLink data, response status code and response headers



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
129
130
131
132
133
134
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_engine_api.rb', line 96

def create_scan_engine_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScanEngineApi.create_scan_engine ...'
  end
  # resource path
  local_var_path = '/api/3/scan_engines'

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

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

#create_shared_secret(opts = {}) ⇒ String

Scan Engine Shared Secret Returns the current valid shared secret or generates a new shared secret. The endpoint returns an existing shared secret if one was previously generated and it has not yet expired. Conversely, the endpoint will generate and return a new shared secret for either of the following conditions: a shared secret was not previously generated or the previously-generated shared secret has expired. The shared secret is valid for 60 minutes from the moment it is generated.

Parameters:

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

    the optional parameters

Returns:

  • (String) 


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

def create_shared_secret(opts = {})
  data, _status_code, _headers = create_shared_secret_with_http_info(opts)
  data
end

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

Scan Engine Shared Secret Returns the current valid shared secret or generates a new shared secret. The endpoint returns an existing shared secret if one was previously generated and it has not yet expired. Conversely, the endpoint will generate and return a new shared secret for either of the following conditions: a shared secret was not previously generated or the previously-generated shared secret has expired. The shared secret is valid for 60 minutes from the moment it is generated.

Parameters:

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



202
203
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
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_engine_api.rb', line 202

def create_shared_secret_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScanEngineApi.create_shared_secret ...'
  end
  # resource path
  local_var_path = '/api/3/scan_engines/shared_secret'

  # 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(['text/plain'])

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

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

Scan Engine Deletes the specified scan engine.

Parameters:

  • id —

    The identifier of the scan engine.

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

    the optional parameters

Returns:



244
245
246
247
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_engine_api.rb', line 244

def delete_scan_engine(site_idte_id, opts = {})
  data, _status_code, _headers = delete_scan_engine_with_http_info(site_idte_id, opts)
  data
end

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

Scan Engine Deletes the specified scan engine.

Parameters:

  • id —

    The identifier of the scan engine.

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

    the optional parameters

Returns:

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

    Links data, response status code and response headers



254
255
256
257
258
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
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_engine_api.rb', line 254

def delete_scan_engine_with_http_info(site_idte_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScanEngineApi.delete_scan_engine ...'
  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 ScanEngineApi.delete_scan_engine"
  end
  # resource path
  local_var_path = '/api/3/scan_engines/{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: ScanEngineApi#delete_scan_engine\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_shared_secret(opts = {}) ⇒ Links

Scan Engine Shared Secret Revokes the current valid shared secret, if one exists.

Parameters:

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

    the optional parameters

Returns:



299
300
301
302
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_engine_api.rb', line 299

def delete_shared_secret(opts = {})
  data, _status_code, _headers = delete_shared_secret_with_http_info(opts)
  data
end

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

Scan Engine Shared Secret Revokes the current valid shared secret, if one exists.

Parameters:

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

    the optional parameters

Returns:

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

    Links data, response status code and response headers



308
309
310
311
312
313
314
315
316
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
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_engine_api.rb', line 308

def delete_shared_secret_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScanEngineApi.delete_shared_secret ...'
  end
  # resource path
  local_var_path = '/api/3/scan_engines/shared_secret'

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

#get_assigned_engine_pools(site_idte_id, opts = {}) ⇒ ResourcesEnginePool

Assigned Engine Pools Retrieves the list of engine pools the scan engine is currently assigned to.

Parameters:

  • id —

    The identifier of the scan engine.

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

    the optional parameters

Returns:



350
351
352
353
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_engine_api.rb', line 350

def get_assigned_engine_pools(site_idte_id, opts = {})
  data, _status_code, _headers = get_assigned_engine_pools_with_http_info(site_idte_id, opts)
  data
end

#get_assigned_engine_pools_with_http_info(site_idte_id, opts = {}) ⇒ Array<(ResourcesEnginePool, Integer, Hash)>

Assigned Engine Pools Retrieves the list of engine pools the scan engine is currently assigned to.

Parameters:

  • id —

    The identifier of the scan engine.

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

    the optional parameters

Returns:

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

    ResourcesEnginePool data, response status code and response headers



360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_engine_api.rb', line 360

def get_assigned_engine_pools_with_http_info(site_idte_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScanEngineApi.get_assigned_engine_pools ...'
  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 ScanEngineApi.get_assigned_engine_pools"
  end
  # resource path
  local_var_path = '/api/3/scan_engines/{id}/scan_engine_pools'.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] || 'ResourcesEnginePool' 

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

#get_current_shared_secret(opts = {}) ⇒ String

Scan Engine Shared Secret Returns the current valid shared secret, if one has been previously generated and it has not yet expired; otherwise the endpoint will respond with a 404 status code. Use this endpoint to detect whether a previously-generated shared secret is still valid.

Parameters:

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

    the optional parameters

Returns:

  • (String) 


405
406
407
408
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_engine_api.rb', line 405

def get_current_shared_secret(opts = {})
  data, _status_code, _headers = get_current_shared_secret_with_http_info(opts)
  data
end

#get_current_shared_secret_time_to_live(opts = {}) ⇒ Integer

Scan Engine Shared Secret Time to live Returns the number of seconds remaining for the current shared secret before it expires, if one has been previously generated and it has not yet expired; otherwise the endpoint will respond with a 404 status code.

Parameters:

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

    the optional parameters

Returns:

  • (Integer) 


455
456
457
458
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_engine_api.rb', line 455

def get_current_shared_secret_time_to_live(opts = {})
  data, _status_code, _headers = get_current_shared_secret_time_to_live_with_http_info(opts)
  data
end

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

Scan Engine Shared Secret Time to live Returns the number of seconds remaining for the current shared secret before it expires, if one has been previously generated and it has not yet expired; otherwise the endpoint will respond with a 404 status code.

Parameters:

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

    the optional parameters

Returns:

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

    Integer data, response status code and response headers



464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_engine_api.rb', line 464

def get_current_shared_secret_time_to_live_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScanEngineApi.get_current_shared_secret_time_to_live ...'
  end
  # resource path
  local_var_path = '/api/3/scan_engines/shared_secret/time_to_live'

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

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

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

Scan Engine Shared Secret Returns the current valid shared secret, if one has been previously generated and it has not yet expired; otherwise the endpoint will respond with a 404 status code. Use this endpoint to detect whether a previously-generated shared secret is still valid.

Parameters:

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_engine_api.rb', line 414

def get_current_shared_secret_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScanEngineApi.get_current_shared_secret ...'
  end
  # resource path
  local_var_path = '/api/3/scan_engines/shared_secret'

  # 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(['text/plain'])

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

#get_engine_pool(site_idte_id, opts = {}) ⇒ EnginePool

Engine Pool Retrieves the details for an engine pool.

Parameters:

  • id —

    The identifier of the engine pool.

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

    the optional parameters

Returns:



506
507
508
509
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_engine_api.rb', line 506

def get_engine_pool(site_idte_id, opts = {})
  data, _status_code, _headers = get_engine_pool_with_http_info(site_idte_id, opts)
  data
end

#get_engine_pool_with_http_info(site_idte_id, opts = {}) ⇒ Array<(EnginePool, Integer, Hash)>

Engine Pool Retrieves the details for an engine pool.

Parameters:

  • id —

    The identifier of the engine pool.

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

    the optional parameters

Returns:

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

    EnginePool data, response status code and response headers



516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_engine_api.rb', line 516

def get_engine_pool_with_http_info(site_idte_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScanEngineApi.get_engine_pool ...'
  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 ScanEngineApi.get_engine_pool"
  end
  # resource path
  local_var_path = '/api/3/scan_engine_pools/{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] || 'EnginePool' 

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

#get_scan_engine(site_idte_id, opts = {}) ⇒ ScanEngine

Scan Engine Retrieves the details for a scan engine.

Parameters:

  • id —

    The identifier of the scan engine.

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

    the optional parameters

Returns:



562
563
564
565
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_engine_api.rb', line 562

def get_scan_engine(site_idte_id, opts = {})
  data, _status_code, _headers = get_scan_engine_with_http_info(site_idte_id, opts)
  data
end

#get_scan_engine_pool_scan_engines(site_idte_id, opts = {}) ⇒ ReferencesWithEngineIDLink

Engine Pool Engines Get the engines in the engine pool.

Parameters:

  • id —

    The identifier of the engine pool.

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

    the optional parameters

Returns:



618
619
620
621
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_engine_api.rb', line 618

def get_scan_engine_pool_scan_engines(site_idte_id, opts = {})
  data, _status_code, _headers = get_scan_engine_pool_scan_engines_with_http_info(site_idte_id, opts)
  data
end

#get_scan_engine_pool_scan_engines_with_http_info(site_idte_id, opts = {}) ⇒ Array<(ReferencesWithEngineIDLink, Integer, Hash)>

Engine Pool Engines Get the engines in the engine pool.

Parameters:

  • id —

    The identifier of the engine pool.

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

    the optional parameters

Returns:

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

    ReferencesWithEngineIDLink data, response status code and response headers



628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_engine_api.rb', line 628

def get_scan_engine_pool_scan_engines_with_http_info(site_idte_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScanEngineApi.get_scan_engine_pool_scan_engines ...'
  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 ScanEngineApi.get_scan_engine_pool_scan_engines"
  end
  # resource path
  local_var_path = '/api/3/scan_engine_pools/{id}/engines'.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] || 'ReferencesWithEngineIDLink' 

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

#get_scan_engine_pool_sites(site_idte_id, opts = {}) ⇒ ReferencesWithSiteIDLink

Engine Pool Sites Returns links to the sites associated with this engine pool.

Parameters:

  • id —

    The identifier of the engine pool.

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

    the optional parameters

Returns:



674
675
676
677
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_engine_api.rb', line 674

def get_scan_engine_pool_sites(site_idte_id, opts = {})
  data, _status_code, _headers = get_scan_engine_pool_sites_with_http_info(site_idte_id, opts)
  data
end

#get_scan_engine_pool_sites_with_http_info(site_idte_id, opts = {}) ⇒ Array<(ReferencesWithSiteIDLink, Integer, Hash)>

Engine Pool Sites Returns links to the sites associated with this engine pool.

Parameters:

  • id —

    The identifier of the engine pool.

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

    the optional parameters

Returns:

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

    ReferencesWithSiteIDLink data, response status code and response headers



684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_engine_api.rb', line 684

def get_scan_engine_pool_sites_with_http_info(site_idte_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScanEngineApi.get_scan_engine_pool_sites ...'
  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 ScanEngineApi.get_scan_engine_pool_sites"
  end
  # resource path
  local_var_path = '/api/3/scan_engine_pools/{id}/sites'.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] || 'ReferencesWithSiteIDLink' 

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

#get_scan_engine_pools(opts = {}) ⇒ ResourcesEnginePool

Engine Pools Returns engine pools available to use for scanning.

Parameters:

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

    the optional parameters

Returns:



729
730
731
732
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_engine_api.rb', line 729

def get_scan_engine_pools(opts = {})
  data, _status_code, _headers = get_scan_engine_pools_with_http_info(opts)
  data
end

#get_scan_engine_pools_with_http_info(opts = {}) ⇒ Array<(ResourcesEnginePool, Integer, Hash)>

Engine Pools Returns engine pools available to use for scanning.

Parameters:

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

    the optional parameters

Returns:

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

    ResourcesEnginePool data, response status code and response headers



738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_engine_api.rb', line 738

def get_scan_engine_pools_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScanEngineApi.get_scan_engine_pools ...'
  end
  # resource path
  local_var_path = '/api/3/scan_engine_pools'

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

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

#get_scan_engine_scans(site_idte_id, opts = {}) ⇒ PageOfScan

Scan Engine Scans Returns the scans that have been run on a scan engine.

Parameters:

  • id —

    The identifier of the scan engine.

  • 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:



783
784
785
786
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_engine_api.rb', line 783

def get_scan_engine_scans(site_idte_id, opts = {})
  data, _status_code, _headers = get_scan_engine_scans_with_http_info(site_idte_id, opts)
  data
end

#get_scan_engine_scans_with_http_info(site_idte_id, opts = {}) ⇒ Array<(PageOfScan, Integer, Hash)>

Scan Engine Scans Returns the scans that have been run on a scan engine.

Parameters:

  • id —

    The identifier of the scan engine.

  • 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:

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

    PageOfScan data, response status code and response headers



796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_engine_api.rb', line 796

def get_scan_engine_scans_with_http_info(site_idte_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScanEngineApi.get_scan_engine_scans ...'
  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 ScanEngineApi.get_scan_engine_scans"
  end
  # resource path
  local_var_path = '/api/3/scan_engines/{id}/scans'.sub('{' + 'id' + '}', site_idte_id.to_s)

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

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

#get_scan_engine_sites(site_idte_id, opts = {}) ⇒ PageOfSite

Scan Engine Sites Retrieves the list of sites the specified scan engine is assigned to.

Parameters:

  • id —

    The identifier of the scan engine.

  • 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:



848
849
850
851
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_engine_api.rb', line 848

def get_scan_engine_sites(site_idte_id, opts = {})
  data, _status_code, _headers = get_scan_engine_sites_with_http_info(site_idte_id, opts)
  data
end

#get_scan_engine_sites_with_http_info(site_idte_id, opts = {}) ⇒ Array<(PageOfSite, Integer, Hash)>

Scan Engine Sites Retrieves the list of sites the specified scan engine is assigned to.

Parameters:

  • id —

    The identifier of the scan engine.

  • 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:

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

    PageOfSite data, response status code and response headers



861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_engine_api.rb', line 861

def get_scan_engine_sites_with_http_info(site_idte_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScanEngineApi.get_scan_engine_sites ...'
  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 ScanEngineApi.get_scan_engine_sites"
  end
  # resource path
  local_var_path = '/api/3/scan_engines/{id}/sites'.sub('{' + 'id' + '}', site_idte_id.to_s)

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

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

#get_scan_engine_with_http_info(site_idte_id, opts = {}) ⇒ Array<(ScanEngine, Integer, Hash)>

Scan Engine Retrieves the details for a scan engine.

Parameters:

  • id —

    The identifier of the scan engine.

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

    the optional parameters

Returns:

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

    ScanEngine data, response status code and response headers



572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_engine_api.rb', line 572

def get_scan_engine_with_http_info(site_idte_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScanEngineApi.get_scan_engine ...'
  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 ScanEngineApi.get_scan_engine"
  end
  # resource path
  local_var_path = '/api/3/scan_engines/{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] || 'ScanEngine' 

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

#get_scan_engines(opts = {}) ⇒ ResourcesScanEngine

Scan Engines Returns scan engines available to use for scanning.

Parameters:

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

    the optional parameters

Returns:



909
910
911
912
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_engine_api.rb', line 909

def get_scan_engines(opts = {})
  data, _status_code, _headers = get_scan_engines_with_http_info(opts)
  data
end

#get_scan_engines_with_http_info(opts = {}) ⇒ Array<(ResourcesScanEngine, Integer, Hash)>

Scan Engines Returns scan engines available to use for scanning.

Parameters:

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

    the optional parameters

Returns:

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

    ResourcesScanEngine data, response status code and response headers



918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_engine_api.rb', line 918

def get_scan_engines_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScanEngineApi.get_scan_engines ...'
  end
  # resource path
  local_var_path = '/api/3/scan_engines'

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

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

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

Engine Pool Deletes the specified engine pool.

Parameters:

  • id —

    The identifier of the engine pool.

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

    the optional parameters

Returns:



960
961
962
963
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_engine_api.rb', line 960

def remove_scan_engine_pool(site_idte_id, opts = {})
  data, _status_code, _headers = remove_scan_engine_pool_with_http_info(site_idte_id, opts)
  data
end

#remove_scan_engine_pool_scan_engine(site_idte_id, engine_id, opts = {}) ⇒ Links

Engine Pool Engines Remove the specified engine from the engine pool.

Parameters:

  • id —

    The identifier of the engine pool.

  • engine_id —

    The identifier of the scan engine.

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

    the optional parameters

Returns:



1017
1018
1019
1020
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_engine_api.rb', line 1017

def remove_scan_engine_pool_scan_engine(site_idte_id, engine_id, opts = {})
  data, _status_code, _headers = remove_scan_engine_pool_scan_engine_with_http_info(site_idte_id, engine_id, opts)
  data
end

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

Engine Pool Engines Remove the specified engine from the engine pool.

Parameters:

  • id —

    The identifier of the engine pool.

  • engine_id —

    The identifier of the scan engine.

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

    the optional parameters

Returns:

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

    Links data, response status code and response headers



1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_engine_api.rb', line 1028

def remove_scan_engine_pool_scan_engine_with_http_info(site_idte_id, engine_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScanEngineApi.remove_scan_engine_pool_scan_engine ...'
  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 ScanEngineApi.remove_scan_engine_pool_scan_engine"
  end
  # verify the required parameter 'engine_id' is set
  if @api_client.config.client_side_validation && engine_id.nil?
    fail ArgumentError, "Missing the required parameter 'engine_id' when calling ScanEngineApi.remove_scan_engine_pool_scan_engine"
  end
  # resource path
  local_var_path = '/api/3/scan_engine_pools/{id}/engines/{engineId}'.sub('{' + 'id' + '}', site_idte_id.to_s).sub('{' + 'engineId' + '}', engine_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: ScanEngineApi#remove_scan_engine_pool_scan_engine\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Engine Pool Deletes the specified engine pool.

Parameters:

  • id —

    The identifier of the engine pool.

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

    the optional parameters

Returns:

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

    Links data, response status code and response headers



970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_engine_api.rb', line 970

def remove_scan_engine_pool_with_http_info(site_idte_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScanEngineApi.remove_scan_engine_pool ...'
  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 ScanEngineApi.remove_scan_engine_pool"
  end
  # resource path
  local_var_path = '/api/3/scan_engine_pools/{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: ScanEngineApi#remove_scan_engine_pool\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Engine Pool Engines Set the engines in the engine pool.

Parameters:

  • id —

    The identifier of the engine pool.

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

    the optional parameters

Options Hash (opts):

  • :body (Array<Integer>) —

    The identifiers of the scan engines to place into the engine pool.

Returns:



1079
1080
1081
1082
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_engine_api.rb', line 1079

def set_scan_engine_pool_scan_engines(site_idte_id, opts = {})
  data, _status_code, _headers = set_scan_engine_pool_scan_engines_with_http_info(site_idte_id, opts)
  data
end

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

Engine Pool Engines Set the engines in the engine pool.

Parameters:

  • id —

    The identifier of the engine pool.

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

    the optional parameters

Options Hash (opts):

  • :body (Array<Integer>) —

    The identifiers of the scan engines to place into the engine pool.

Returns:

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

    Links data, response status code and response headers



1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_engine_api.rb', line 1090

def set_scan_engine_pool_scan_engines_with_http_info(site_idte_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScanEngineApi.set_scan_engine_pool_scan_engines ...'
  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 ScanEngineApi.set_scan_engine_pool_scan_engines"
  end
  # resource path
  local_var_path = '/api/3/scan_engine_pools/{id}/engines'.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(opts[:'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: ScanEngineApi#set_scan_engine_pool_scan_engines\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Scan Engine Updates the specified scan engine.

Parameters:

  • id —

    The identifier of the scan engine.

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

    the optional parameters

Options Hash (opts):

  • :body (ScanEngine) —

    The specification of the scan engine to update.

Returns:



1139
1140
1141
1142
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_engine_api.rb', line 1139

def update_scan_engine(site_idte_id, opts = {})
  data, _status_code, _headers = update_scan_engine_with_http_info(site_idte_id, opts)
  data
end

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

Engine Pool Updates the specified engine pool.

Parameters:

  • id —

    The identifier of the engine pool.

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

    the optional parameters

Options Hash (opts):

  • :body (EnginePool) —

    The details for the scan engine to update.

Returns:



1199
1200
1201
1202
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_engine_api.rb', line 1199

def update_scan_engine_pool(site_idte_id, opts = {})
  data, _status_code, _headers = update_scan_engine_pool_with_http_info(site_idte_id, opts)
  data
end

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

Engine Pool Updates the specified engine pool.

Parameters:

  • id —

    The identifier of the engine pool.

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

    the optional parameters

Options Hash (opts):

  • :body (EnginePool) —

    The details for the scan engine to update.

Returns:

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

    Links data, response status code and response headers



1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_engine_api.rb', line 1210

def update_scan_engine_pool_with_http_info(site_idte_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScanEngineApi.update_scan_engine_pool ...'
  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 ScanEngineApi.update_scan_engine_pool"
  end
  # resource path
  local_var_path = '/api/3/scan_engine_pools/{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'])
  # 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(: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: ScanEngineApi#update_scan_engine_pool\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Scan Engine Updates the specified scan engine.

Parameters:

  • id —

    The identifier of the scan engine.

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

    the optional parameters

Options Hash (opts):

  • :body (ScanEngine) —

    The specification of the scan engine to update.

Returns:

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

    Links data, response status code and response headers



1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_engine_api.rb', line 1150

def update_scan_engine_with_http_info(site_idte_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScanEngineApi.update_scan_engine ...'
  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 ScanEngineApi.update_scan_engine"
  end
  # resource path
  local_var_path = '/api/3/scan_engines/{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'])
  # 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(: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: ScanEngineApi#update_scan_engine\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end