Class: SwaggerClient::SiteApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SiteApi

Returns a new instance of SiteApi.



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

def api_client
  @api_client
end

Instance Method Details

#add_excluded_targets(site_idte_id, opts = {}) ⇒ ReferenceWithSiteIDLink

Site Excluded Targets Adds one or more addresses to the site’s list of excluded scan targets.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

  • :body (Array<String>) —

    List of addresses to add to the site&#x27;s excluded scan targets. Each address is a string that can represent either a hostname, ipv4 address, ipv4 address range, ipv6 address, or CIDR notation.

Returns:



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

def add_excluded_targets(site_idte_id, opts = {})
  data, _status_code, _headers = add_excluded_targets_with_http_info(site_idte_id, opts)
  data
end

#add_excluded_targets_with_http_info(site_idte_id, opts = {}) ⇒ Array<(ReferenceWithSiteIDLink, Integer, Hash)>

Site Excluded Targets Adds one or more addresses to the site&#x27;s list of excluded scan targets.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

  • :body (Array<String>) —

    List of addresses to add to the site&#x27;s excluded scan targets. Each address is a string that can represent either a hostname, ipv4 address, ipv4 address range, ipv6 address, or CIDR notation.

Returns:

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

    ReferenceWithSiteIDLink 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
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 36

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

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

#add_included_targets(site_idte_id, opts = {}) ⇒ ReferenceWithSiteIDLink

Site Included Targets Adds one or more addresses to the site’s list of included scan targets.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

  • :body (Array<String>) —

    List of addresses to add to the site&#x27;s included scan targets. Each address is a string that can represent either a hostname, ipv4 address, ipv4 address range, ipv6 address, or CIDR notation.

Returns:



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

def add_included_targets(site_idte_id, opts = {})
  data, _status_code, _headers = add_included_targets_with_http_info(site_idte_id, opts)
  data
end

#add_included_targets_with_http_info(site_idte_id, opts = {}) ⇒ Array<(ReferenceWithSiteIDLink, Integer, Hash)>

Site Included Targets Adds one or more addresses to the site&#x27;s list of included scan targets.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

  • :body (Array<String>) —

    List of addresses to add to the site&#x27;s included scan targets. Each address is a string that can represent either a hostname, ipv4 address, ipv4 address range, ipv6 address, or CIDR notation.

Returns:

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

    ReferenceWithSiteIDLink 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
135
136
137
138
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 96

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

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

#add_site_tag(site_idte_id, tag_id, opts = {}) ⇒ Links

Site Tag Adds a tag to the site.

Parameters:

  • id —

    The identifier of the site.

  • tag_id —

    The identifier of the tag.

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

    the optional parameters

Returns:



145
146
147
148
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 145

def add_site_tag(site_idte_id, tag_id, opts = {})
  data, _status_code, _headers = add_site_tag_with_http_info(site_idte_id, tag_id, opts)
  data
end

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

Site Tag Adds a tag to the site.

Parameters:

  • id —

    The identifier of the site.

  • tag_id —

    The identifier of the tag.

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

    the optional parameters

Returns:

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

    Links data, response status code and response headers



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
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 156

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

#add_site_user(site_idte_id, opts = {}) ⇒ ReferenceWithUserIDLink

Site Users Access Grants a non-administrator user access to the specified site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

  • :body (Integer) —

    The identifier of the user.

Returns:



207
208
209
210
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 207

def add_site_user(site_idte_id, opts = {})
  data, _status_code, _headers = add_site_user_with_http_info(site_idte_id, opts)
  data
end

#add_site_user_with_http_info(site_idte_id, opts = {}) ⇒ Array<(ReferenceWithUserIDLink, Integer, Hash)>

Site Users Access Grants a non-administrator user access to the specified site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

  • :body (Integer) —

    The identifier of the user.

Returns:

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

    ReferenceWithUserIDLink data, response status code and response headers



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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 218

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

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

#create_site(opts = {}) ⇒ ReferenceWithSiteIDLink

Sites Creates a new site with the specified configuration.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



266
267
268
269
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 266

def create_site(opts = {})
  data, _status_code, _headers = create_site_with_http_info(opts)
  data
end

#create_site_credential(site_idte_id, opts = {}) ⇒ CreatedReferenceCredentialIDLink

Site Scan Credentials Creates a new site credential.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

Returns:



321
322
323
324
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 321

def create_site_credential(site_idte_id, opts = {})
  data, _status_code, _headers = create_site_credential_with_http_info(site_idte_id, opts)
  data
end

#create_site_credential_with_http_info(site_idte_id, opts = {}) ⇒ Array<(CreatedReferenceCredentialIDLink, Integer, Hash)>

Site Scan Credentials Creates a new site credential.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

Returns:



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
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 332

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

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

#create_site_scan_schedule(site_idte_id, opts = {}) ⇒ ReferenceWithScanScheduleIDLink

Site Scan Schedules Creates a new scan schedule for the specified site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

Returns:



381
382
383
384
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 381

def create_site_scan_schedule(site_idte_id, opts = {})
  data, _status_code, _headers = create_site_scan_schedule_with_http_info(site_idte_id, opts)
  data
end

#create_site_scan_schedule_with_http_info(site_idte_id, opts = {}) ⇒ Array<(ReferenceWithScanScheduleIDLink, Integer, Hash)>

Site Scan Schedules Creates a new scan schedule for the specified site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

Returns:



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
434
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 392

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

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

#create_site_smtp_alert(site_idte_id, opts = {}) ⇒ ReferenceWithAlertIDLink

Site SMTP Alerts Creates a new SMTP alert for the specified site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

  • :body (SmtpAlert) —

    Resource for creating a new SMTP alert.

Returns:



441
442
443
444
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 441

def create_site_smtp_alert(site_idte_id, opts = {})
  data, _status_code, _headers = create_site_smtp_alert_with_http_info(site_idte_id, opts)
  data
end

#create_site_smtp_alert_with_http_info(site_idte_id, opts = {}) ⇒ Array<(ReferenceWithAlertIDLink, Integer, Hash)>

Site SMTP Alerts Creates a new SMTP alert for the specified site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

  • :body (SmtpAlert) —

    Resource for creating a new SMTP alert.

Returns:

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

    ReferenceWithAlertIDLink data, response status code and response headers



452
453
454
455
456
457
458
459
460
461
462
463
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
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 452

def create_site_smtp_alert_with_http_info(site_idte_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SiteApi.create_site_smtp_alert ...'
  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 SiteApi.create_site_smtp_alert"
  end
  # resource path
  local_var_path = '/api/3/sites/{id}/alerts/smtp'.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] || 'ReferenceWithAlertIDLink' 

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

#create_site_snmp_alert(site_idte_id, opts = {}) ⇒ ReferenceWithAlertIDLink

Site SNMP Alerts Creates a new SNMP alert for the specified site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

  • :body (SnmpAlert) —

    Resource for creating a new SNMP alert.

Returns:



501
502
503
504
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 501

def create_site_snmp_alert(site_idte_id, opts = {})
  data, _status_code, _headers = create_site_snmp_alert_with_http_info(site_idte_id, opts)
  data
end

#create_site_snmp_alert_with_http_info(site_idte_id, opts = {}) ⇒ Array<(ReferenceWithAlertIDLink, Integer, Hash)>

Site SNMP Alerts Creates a new SNMP alert for the specified site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

  • :body (SnmpAlert) —

    Resource for creating a new SNMP alert.

Returns:

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

    ReferenceWithAlertIDLink data, response status code and response headers



512
513
514
515
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
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 512

def create_site_snmp_alert_with_http_info(site_idte_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SiteApi.create_site_snmp_alert ...'
  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 SiteApi.create_site_snmp_alert"
  end
  # resource path
  local_var_path = '/api/3/sites/{id}/alerts/snmp'.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] || 'ReferenceWithAlertIDLink' 

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

#create_site_syslog_alert(site_idte_id, opts = {}) ⇒ ReferenceWithAlertIDLink

Site Syslog Alerts Creates a new Syslog alert for the specified site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

  • :body (SyslogAlert) —

    Resource for creating a new Syslog alert.

Returns:



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

def create_site_syslog_alert(site_idte_id, opts = {})
  data, _status_code, _headers = create_site_syslog_alert_with_http_info(site_idte_id, opts)
  data
end

#create_site_syslog_alert_with_http_info(site_idte_id, opts = {}) ⇒ Array<(ReferenceWithAlertIDLink, Integer, Hash)>

Site Syslog Alerts Creates a new Syslog alert for the specified site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

  • :body (SyslogAlert) —

    Resource for creating a new Syslog alert.

Returns:

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

    ReferenceWithAlertIDLink 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
613
614
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 572

def create_site_syslog_alert_with_http_info(site_idte_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SiteApi.create_site_syslog_alert ...'
  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 SiteApi.create_site_syslog_alert"
  end
  # resource path
  local_var_path = '/api/3/sites/{id}/alerts/syslog'.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] || 'ReferenceWithAlertIDLink' 

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

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

Sites Creates a new site with the specified configuration.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    ReferenceWithSiteIDLink data, response status code and response headers



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 276

def create_site_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SiteApi.create_site ...'
  end
  # resource path
  local_var_path = '/api/3/sites'

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

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

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

Site Alerts Deletes all alerts from the site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:



620
621
622
623
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 620

def delete_all_site_alerts(site_idte_id, opts = {})
  data, _status_code, _headers = delete_all_site_alerts_with_http_info(site_idte_id, opts)
  data
end

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

Site Alerts Deletes all alerts from the site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:

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

    Links data, response status code and response headers



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
669
670
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 630

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

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

Site Scan Credentials Deletes all site credentials from the site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:



676
677
678
679
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 676

def delete_all_site_credentials(site_idte_id, opts = {})
  data, _status_code, _headers = delete_all_site_credentials_with_http_info(site_idte_id, opts)
  data
end

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

Site Scan Credentials Deletes all site credentials from the site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:

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

    Links data, response status code and response headers



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
725
726
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 686

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

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

Site Scan Schedules Deletes all scan schedules from the site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:



732
733
734
735
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 732

def delete_all_site_scan_schedules(site_idte_id, opts = {})
  data, _status_code, _headers = delete_all_site_scan_schedules_with_http_info(site_idte_id, opts)
  data
end

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

Site Scan Schedules Deletes all scan schedules from the site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:

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

    Links data, response status code and response headers



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
775
776
777
778
779
780
781
782
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 742

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

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

Site SMTP Alerts Deletes all SMTP alerts from the site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:



788
789
790
791
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 788

def delete_all_site_smtp_alerts(site_idte_id, opts = {})
  data, _status_code, _headers = delete_all_site_smtp_alerts_with_http_info(site_idte_id, opts)
  data
end

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

Site SMTP Alerts Deletes all SMTP alerts from the site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:

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

    Links data, response status code and response headers



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

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

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

Site SNMP Alerts Deletes all SNMP alerts from the site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:



844
845
846
847
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 844

def delete_all_site_snmp_alerts(site_idte_id, opts = {})
  data, _status_code, _headers = delete_all_site_snmp_alerts_with_http_info(site_idte_id, opts)
  data
end

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

Site SNMP Alerts Deletes all SNMP alerts from the site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:

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

    Links data, response status code and response headers



854
855
856
857
858
859
860
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
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 854

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

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

Site Syslog Alerts Deletes all Syslog alerts from the site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:



900
901
902
903
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 900

def delete_all_site_syslog_alerts(site_idte_id, opts = {})
  data, _status_code, _headers = delete_all_site_syslog_alerts_with_http_info(site_idte_id, opts)
  data
end

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

Site Syslog Alerts Deletes all Syslog alerts from the site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:

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

    Links data, response status code and response headers



910
911
912
913
914
915
916
917
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
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 910

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

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

Site Deletes the site with the specified identifier.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:



956
957
958
959
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 956

def delete_site(site_idte_id, opts = {})
  data, _status_code, _headers = delete_site_with_http_info(site_idte_id, opts)
  data
end

#delete_site_credential(site_idte_id, credential_id, opts = {}) ⇒ Links

Site Scan Credential Deletes the specified site credential.

Parameters:

  • id —

    The identifier of the site.

  • credential_id —

    The identifier of the site credential.

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

    the optional parameters

Returns:



1013
1014
1015
1016
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 1013

def delete_site_credential(site_idte_id, credential_id, opts = {})
  data, _status_code, _headers = delete_site_credential_with_http_info(site_idte_id, credential_id, opts)
  data
end

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

Site Scan Credential Deletes the specified site credential.

Parameters:

  • id —

    The identifier of the site.

  • credential_id —

    The identifier of the site credential.

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

    the optional parameters

Returns:

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

    Links data, response status code and response headers



1024
1025
1026
1027
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
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 1024

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

#delete_site_scan_schedule(site_idte_id, schedule_id, opts = {}) ⇒ Links

Site Scan Schedule Deletes the specified scan schedule from the site.

Parameters:

  • id —

    The identifier of the site.

  • schedule_id —

    The identifier of the scan schedule.

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

    the optional parameters

Returns:



1075
1076
1077
1078
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 1075

def delete_site_scan_schedule(site_idte_id, schedule_id, opts = {})
  data, _status_code, _headers = delete_site_scan_schedule_with_http_info(site_idte_id, schedule_id, opts)
  data
end

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

Site Scan Schedule Deletes the specified scan schedule from the site.

Parameters:

  • id —

    The identifier of the site.

  • schedule_id —

    The identifier of the scan schedule.

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

    the optional parameters

Returns:

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

    Links data, response status code and response headers



1086
1087
1088
1089
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
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 1086

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

#delete_site_smtp_alert(site_idte_id, alert_id, opts = {}) ⇒ Links

Site SMTP Alert Deletes the specified SMTP alert from the site.

Parameters:

  • id —

    The identifier of the site.

  • alert_id —

    The identifier of the alert.

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

    the optional parameters

Returns:



1137
1138
1139
1140
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 1137

def delete_site_smtp_alert(site_idte_id, alert_id, opts = {})
  data, _status_code, _headers = delete_site_smtp_alert_with_http_info(site_idte_id, alert_id, opts)
  data
end

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

Site SMTP Alert Deletes the specified SMTP alert from the site.

Parameters:

  • id —

    The identifier of the site.

  • alert_id —

    The identifier of the alert.

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

    the optional parameters

Returns:

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

    Links data, response status code and response headers



1148
1149
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/site_api.rb', line 1148

def delete_site_smtp_alert_with_http_info(site_idte_id, alert_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SiteApi.delete_site_smtp_alert ...'
  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 SiteApi.delete_site_smtp_alert"
  end
  # verify the required parameter 'alert_id' is set
  if @api_client.config.client_side_validation && alert_id.nil?
    fail ArgumentError, "Missing the required parameter 'alert_id' when calling SiteApi.delete_site_smtp_alert"
  end
  # resource path
  local_var_path = '/api/3/sites/{id}/alerts/smtp/{alertId}'.sub('{' + 'id' + '}', site_idte_id.to_s).sub('{' + 'alertId' + '}', alert_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: SiteApi#delete_site_smtp_alert\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_site_snmp_alert(site_idte_id, alert_id, opts = {}) ⇒ Links

Site SNMP Alert Deletes the specified SNMP alert from the site.

Parameters:

  • id —

    The identifier of the site.

  • alert_id —

    The identifier of the alert.

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

    the optional parameters

Returns:



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

def delete_site_snmp_alert(site_idte_id, alert_id, opts = {})
  data, _status_code, _headers = delete_site_snmp_alert_with_http_info(site_idte_id, alert_id, opts)
  data
end

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

Site SNMP Alert Deletes the specified SNMP alert from the site.

Parameters:

  • id —

    The identifier of the site.

  • alert_id —

    The identifier of the alert.

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

    the optional parameters

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
1253
1254
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 1210

def delete_site_snmp_alert_with_http_info(site_idte_id, alert_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SiteApi.delete_site_snmp_alert ...'
  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 SiteApi.delete_site_snmp_alert"
  end
  # verify the required parameter 'alert_id' is set
  if @api_client.config.client_side_validation && alert_id.nil?
    fail ArgumentError, "Missing the required parameter 'alert_id' when calling SiteApi.delete_site_snmp_alert"
  end
  # resource path
  local_var_path = '/api/3/sites/{id}/alerts/snmp/{alertId}'.sub('{' + 'id' + '}', site_idte_id.to_s).sub('{' + 'alertId' + '}', alert_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: SiteApi#delete_site_snmp_alert\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_site_syslog_alert(site_idte_id, alert_id, opts = {}) ⇒ Links

Site Syslog Alert Deletes the specified Syslog alert from the site.

Parameters:

  • id —

    The identifier of the site.

  • alert_id —

    The identifier of the alert.

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

    the optional parameters

Returns:



1261
1262
1263
1264
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 1261

def delete_site_syslog_alert(site_idte_id, alert_id, opts = {})
  data, _status_code, _headers = delete_site_syslog_alert_with_http_info(site_idte_id, alert_id, opts)
  data
end

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

Site Syslog Alert Deletes the specified Syslog alert from the site.

Parameters:

  • id —

    The identifier of the site.

  • alert_id —

    The identifier of the alert.

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

    the optional parameters

Returns:

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

    Links data, response status code and response headers



1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 1272

def delete_site_syslog_alert_with_http_info(site_idte_id, alert_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SiteApi.delete_site_syslog_alert ...'
  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 SiteApi.delete_site_syslog_alert"
  end
  # verify the required parameter 'alert_id' is set
  if @api_client.config.client_side_validation && alert_id.nil?
    fail ArgumentError, "Missing the required parameter 'alert_id' when calling SiteApi.delete_site_syslog_alert"
  end
  # resource path
  local_var_path = '/api/3/sites/{id}/alerts/syslog/{alertId}'.sub('{' + 'id' + '}', site_idte_id.to_s).sub('{' + 'alertId' + '}', alert_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: SiteApi#delete_site_syslog_alert\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Site Deletes the site with the specified identifier.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:

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

    Links data, response status code and response headers



966
967
968
969
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
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 966

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

#enable_shared_credential_on_site(site_idte_id, credential_id, opts = {}) ⇒ Links

Assigned Shared Credential Enablement Enable or disable the shared credential for the site’s scans.

Parameters:

  • id —

    The identifier of the site.

  • credential_id —

    The identifier of the shared credential.

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

    the optional parameters

Options Hash (opts):

  • :body (BOOLEAN) —

    Flag indicating whether the shared credential is enabled for the site&#x27;s scans.

Returns:



1324
1325
1326
1327
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 1324

def enable_shared_credential_on_site(site_idte_id, credential_id, opts = {})
  data, _status_code, _headers = enable_shared_credential_on_site_with_http_info(site_idte_id, credential_id, opts)
  data
end

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

Assigned Shared Credential Enablement Enable or disable the shared credential for the site&#x27;s scans.

Parameters:

  • id —

    The identifier of the site.

  • credential_id —

    The identifier of the shared credential.

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

    the optional parameters

Options Hash (opts):

  • :body (BOOLEAN) —

    Flag indicating whether the shared credential is enabled for the site&#x27;s scans.

Returns:

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

    Links data, response status code and response headers



1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 1336

def enable_shared_credential_on_site_with_http_info(site_idte_id, credential_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SiteApi.enable_shared_credential_on_site ...'
  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 SiteApi.enable_shared_credential_on_site"
  end
  # verify the required parameter 'credential_id' is set
  if @api_client.config.client_side_validation && credential_id.nil?
    fail ArgumentError, "Missing the required parameter 'credential_id' when calling SiteApi.enable_shared_credential_on_site"
  end
  # resource path
  local_var_path = '/api/3/sites/{id}/shared_credentials/{credentialId}/enabled'.sub('{' + 'id' + '}', site_idte_id.to_s).sub('{' + 'credentialId' + '}', credential_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: SiteApi#enable_shared_credential_on_site\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#enable_site_credential(site_idte_id, credential_id, opts = {}) ⇒ Links

Site Credential Enablement Enable or disable the site credential for scans.

Parameters:

  • id —

    The identifier of the site.

  • credential_id —

    The identifier of the site credential.

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

    the optional parameters

Options Hash (opts):

  • :body (BOOLEAN) —

    Flag indicating whether the credential is enabled for use during the scan.

Returns:



1390
1391
1392
1393
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 1390

def enable_site_credential(site_idte_id, credential_id, opts = {})
  data, _status_code, _headers = enable_site_credential_with_http_info(site_idte_id, credential_id, opts)
  data
end

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

Site Credential Enablement Enable or disable the site credential for scans.

Parameters:

  • id —

    The identifier of the site.

  • credential_id —

    The identifier of the site credential.

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

    the optional parameters

Options Hash (opts):

  • :body (BOOLEAN) —

    Flag indicating whether the credential is enabled for use during the scan.

Returns:

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

    Links data, response status code and response headers



1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 1402

def enable_site_credential_with_http_info(site_idte_id, credential_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SiteApi.enable_site_credential ...'
  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 SiteApi.enable_site_credential"
  end
  # verify the required parameter 'credential_id' is set
  if @api_client.config.client_side_validation && credential_id.nil?
    fail ArgumentError, "Missing the required parameter 'credential_id' when calling SiteApi.enable_site_credential"
  end
  # resource path
  local_var_path = '/api/3/sites/{id}/site_credentials/{credentialId}/enabled'.sub('{' + 'id' + '}', site_idte_id.to_s).sub('{' + 'credentialId' + '}', credential_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: SiteApi#enable_site_credential\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_excluded_asset_groups(site_idte_id, opts = {}) ⇒ ResourcesAssetGroup

Site Excluded Asset Groups Retrieves the excluded asset groups in a static site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:



1454
1455
1456
1457
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 1454

def get_excluded_asset_groups(site_idte_id, opts = {})
  data, _status_code, _headers = get_excluded_asset_groups_with_http_info(site_idte_id, opts)
  data
end

#get_excluded_asset_groups_with_http_info(site_idte_id, opts = {}) ⇒ Array<(ResourcesAssetGroup, Integer, Hash)>

Site Excluded Asset Groups Retrieves the excluded asset groups in a static site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:

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

    ResourcesAssetGroup data, response status code and response headers



1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 1464

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

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

#get_excluded_targets(site_idte_id, opts = {}) ⇒ ScanTargetsResource

Site Excluded Targets Retrieves the excluded targets in a static site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:



1510
1511
1512
1513
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 1510

def get_excluded_targets(site_idte_id, opts = {})
  data, _status_code, _headers = get_excluded_targets_with_http_info(site_idte_id, opts)
  data
end

#get_excluded_targets_with_http_info(site_idte_id, opts = {}) ⇒ Array<(ScanTargetsResource, Integer, Hash)>

Site Excluded Targets Retrieves the excluded targets in a static site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:

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

    ScanTargetsResource data, response status code and response headers



1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 1520

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

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

#get_included_asset_groups(site_idte_id, opts = {}) ⇒ ResourcesAssetGroup

Site Included Asset Groups Retrieves the included asset groups in a static site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:



1566
1567
1568
1569
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 1566

def get_included_asset_groups(site_idte_id, opts = {})
  data, _status_code, _headers = get_included_asset_groups_with_http_info(site_idte_id, opts)
  data
end

#get_included_asset_groups_with_http_info(site_idte_id, opts = {}) ⇒ Array<(ResourcesAssetGroup, Integer, Hash)>

Site Included Asset Groups Retrieves the included asset groups in a static site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:

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

    ResourcesAssetGroup data, response status code and response headers



1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 1576

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

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

#get_included_targets(site_idte_id, opts = {}) ⇒ ScanTargetsResource

Site Included Targets Retrieves the included targets in a static site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:



1622
1623
1624
1625
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 1622

def get_included_targets(site_idte_id, opts = {})
  data, _status_code, _headers = get_included_targets_with_http_info(site_idte_id, opts)
  data
end

#get_included_targets_with_http_info(site_idte_id, opts = {}) ⇒ Array<(ScanTargetsResource, Integer, Hash)>

Site Included Targets Retrieves the included targets in a static site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:

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

    ScanTargetsResource data, response status code and response headers



1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 1632

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

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

#get_site(site_idte_id, opts = {}) ⇒ Site

Site Retrieves the site with the specified identifier.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:



1678
1679
1680
1681
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 1678

def get_site(site_idte_id, opts = {})
  data, _status_code, _headers = get_site_with_http_info(site_idte_id, opts)
  data
end

#get_site_alerts(site_idte_id, opts = {}) ⇒ ResourcesAlert

Site Alerts Retrieve all alerts defined in the site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:



1734
1735
1736
1737
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 1734

def get_site_alerts(site_idte_id, opts = {})
  data, _status_code, _headers = get_site_alerts_with_http_info(site_idte_id, opts)
  data
end

#get_site_alerts_with_http_info(site_idte_id, opts = {}) ⇒ Array<(ResourcesAlert, Integer, Hash)>

Site Alerts Retrieve all alerts defined in the site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:

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

    ResourcesAlert data, response status code and response headers



1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 1744

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

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

#get_site_assets(site_idte_id, opts = {}) ⇒ PageOfAsset

Site Assets Retrieves a paged resource of assets linked with the specified site.

Parameters:

  • id —

    The identifier of the site.

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



1793
1794
1795
1796
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 1793

def get_site_assets(site_idte_id, opts = {})
  data, _status_code, _headers = get_site_assets_with_http_info(site_idte_id, opts)
  data
end

#get_site_assets_with_http_info(site_idte_id, opts = {}) ⇒ Array<(PageOfAsset, Integer, Hash)>

Site Assets Retrieves a paged resource of assets linked with the specified site.

Parameters:

  • id —

    The identifier of the site.

  • 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<(PageOfAsset, Integer, Hash)>) —

    PageOfAsset data, response status code and response headers



1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 1806

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

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

#get_site_credential(site_idte_id, credential_id, opts = {}) ⇒ SiteCredential

Site Scan Credential Retrieves the specified site credential.

Parameters:

  • id —

    The identifier of the site.

  • credential_id —

    The identifier of the site credential.

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

    the optional parameters

Returns:



1856
1857
1858
1859
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 1856

def get_site_credential(site_idte_id, credential_id, opts = {})
  data, _status_code, _headers = get_site_credential_with_http_info(site_idte_id, credential_id, opts)
  data
end

#get_site_credential_with_http_info(site_idte_id, credential_id, opts = {}) ⇒ Array<(SiteCredential, Integer, Hash)>

Site Scan Credential Retrieves the specified site credential.

Parameters:

  • id —

    The identifier of the site.

  • credential_id —

    The identifier of the site credential.

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

    the optional parameters

Returns:

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

    SiteCredential data, response status code and response headers



1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 1867

def get_site_credential_with_http_info(site_idte_id, credential_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SiteApi.get_site_credential ...'
  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 SiteApi.get_site_credential"
  end
  # verify the required parameter 'credential_id' is set
  if @api_client.config.client_side_validation && credential_id.nil?
    fail ArgumentError, "Missing the required parameter 'credential_id' when calling SiteApi.get_site_credential"
  end
  # resource path
  local_var_path = '/api/3/sites/{id}/site_credentials/{credentialId}'.sub('{' + 'id' + '}', site_idte_id.to_s).sub('{' + 'credentialId' + '}', credential_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] || 'SiteCredential' 

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

#get_site_credentials(site_idte_id, opts = {}) ⇒ ResourcesSiteCredential

Site Scan Credentials Retrieves all defined site credential resources.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:



1917
1918
1919
1920
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 1917

def get_site_credentials(site_idte_id, opts = {})
  data, _status_code, _headers = get_site_credentials_with_http_info(site_idte_id, opts)
  data
end

#get_site_credentials_with_http_info(site_idte_id, opts = {}) ⇒ Array<(ResourcesSiteCredential, Integer, Hash)>

Site Scan Credentials Retrieves all defined site credential resources.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:

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

    ResourcesSiteCredential data, response status code and response headers



1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 1927

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

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

#get_site_discovery_connection(site_idte_id, opts = {}) ⇒ SiteDiscoveryConnection

Site Discovery Connection Retrieves the discovery connection assigned to the site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:



1973
1974
1975
1976
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 1973

def get_site_discovery_connection(site_idte_id, opts = {})
  data, _status_code, _headers = get_site_discovery_connection_with_http_info(site_idte_id, opts)
  data
end

#get_site_discovery_connection_with_http_info(site_idte_id, opts = {}) ⇒ Array<(SiteDiscoveryConnection, Integer, Hash)>

Site Discovery Connection Retrieves the discovery connection assigned to the site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:

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

    SiteDiscoveryConnection data, response status code and response headers



1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 1983

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

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

#get_site_discovery_search_criteria(site_idte_id, opts = {}) ⇒ DiscoverySearchCriteria

Site Discovery Search Criteria Retrieve the search criteria of the dynamic site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:



2029
2030
2031
2032
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 2029

def get_site_discovery_search_criteria(site_idte_id, opts = {})
  data, _status_code, _headers = get_site_discovery_search_criteria_with_http_info(site_idte_id, opts)
  data
end

#get_site_discovery_search_criteria_with_http_info(site_idte_id, opts = {}) ⇒ Array<(DiscoverySearchCriteria, Integer, Hash)>

Site Discovery Search Criteria Retrieve the search criteria of the dynamic site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:

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

    DiscoverySearchCriteria data, response status code and response headers



2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 2039

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

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

#get_site_organization(site_idte_id, opts = {}) ⇒ SiteOrganization

Site Organization Information Retrieves the site organization information.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:



2085
2086
2087
2088
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 2085

def get_site_organization(site_idte_id, opts = {})
  data, _status_code, _headers = get_site_organization_with_http_info(site_idte_id, opts)
  data
end

#get_site_organization_with_http_info(site_idte_id, opts = {}) ⇒ Array<(SiteOrganization, Integer, Hash)>

Site Organization Information Retrieves the site organization information.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:

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

    SiteOrganization data, response status code and response headers



2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 2095

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

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

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

Site Scan Engine Retrieves the resource of the scan engine assigned to the site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:



2141
2142
2143
2144
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 2141

def get_site_scan_engine(site_idte_id, opts = {})
  data, _status_code, _headers = get_site_scan_engine_with_http_info(site_idte_id, opts)
  data
end

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

Site Scan Engine Retrieves the resource of the scan engine assigned to the site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:

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

    ScanEngine data, response status code and response headers



2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 2151

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

#get_site_scan_schedule(site_idte_id, schedule_id, opts = {}) ⇒ ScanSchedule

Site Scan Schedule Retrieves the specified scan schedule.

Parameters:

  • id —

    The identifier of the site.

  • schedule_id —

    The identifier of the scan schedule.

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

    the optional parameters

Returns:



2198
2199
2200
2201
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 2198

def get_site_scan_schedule(site_idte_id, schedule_id, opts = {})
  data, _status_code, _headers = get_site_scan_schedule_with_http_info(site_idte_id, schedule_id, opts)
  data
end

#get_site_scan_schedule_with_http_info(site_idte_id, schedule_id, opts = {}) ⇒ Array<(ScanSchedule, Integer, Hash)>

Site Scan Schedule Retrieves the specified scan schedule.

Parameters:

  • id —

    The identifier of the site.

  • schedule_id —

    The identifier of the scan schedule.

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

    the optional parameters

Returns:

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

    ScanSchedule data, response status code and response headers



2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 2209

def get_site_scan_schedule_with_http_info(site_idte_id, schedule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SiteApi.get_site_scan_schedule ...'
  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 SiteApi.get_site_scan_schedule"
  end
  # verify the required parameter 'schedule_id' is set
  if @api_client.config.client_side_validation && schedule_id.nil?
    fail ArgumentError, "Missing the required parameter 'schedule_id' when calling SiteApi.get_site_scan_schedule"
  end
  # resource path
  local_var_path = '/api/3/sites/{id}/scan_schedules/{scheduleId}'.sub('{' + 'id' + '}', site_idte_id.to_s).sub('{' + 'scheduleId' + '}', schedule_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] || 'ScanSchedule' 

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

#get_site_scan_schedules(site_idte_id, opts = {}) ⇒ ResourcesScanSchedule

Site Scan Schedules Returns all scan schedules for the site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:



2259
2260
2261
2262
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 2259

def get_site_scan_schedules(site_idte_id, opts = {})
  data, _status_code, _headers = get_site_scan_schedules_with_http_info(site_idte_id, opts)
  data
end

#get_site_scan_schedules_with_http_info(site_idte_id, opts = {}) ⇒ Array<(ResourcesScanSchedule, Integer, Hash)>

Site Scan Schedules Returns all scan schedules for the site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:

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

    ResourcesScanSchedule data, response status code and response headers



2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 2269

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

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

#get_site_scan_template(site_idte_id, opts = {}) ⇒ ScanTemplate

Site Scan Template Retrieves the resource of the scan template assigned to the site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:



2315
2316
2317
2318
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 2315

def get_site_scan_template(site_idte_id, opts = {})
  data, _status_code, _headers = get_site_scan_template_with_http_info(site_idte_id, opts)
  data
end

#get_site_scan_template_with_http_info(site_idte_id, opts = {}) ⇒ Array<(ScanTemplate, Integer, Hash)>

Site Scan Template Retrieves the resource of the scan template assigned to the site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:

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

    ScanTemplate data, response status code and response headers



2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 2325

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

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

#get_site_shared_credentials(site_idte_id, opts = {}) ⇒ ResourcesSiteSharedCredential

Assigned Shared Credentials Retrieve all of the shared credentials assigned to the site. These shared credentials can be enabled/disabled for the site’s scan.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:



2371
2372
2373
2374
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 2371

def get_site_shared_credentials(site_idte_id, opts = {})
  data, _status_code, _headers = get_site_shared_credentials_with_http_info(site_idte_id, opts)
  data
end

#get_site_shared_credentials_with_http_info(site_idte_id, opts = {}) ⇒ Array<(ResourcesSiteSharedCredential, Integer, Hash)>

Assigned Shared Credentials Retrieve all of the shared credentials assigned to the site. These shared credentials can be enabled/disabled for the site&#x27;s scan.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:



2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 2381

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

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

#get_site_smtp_alert(site_idte_id, alert_id, opts = {}) ⇒ SmtpAlert

Site SMTP Alert Retrieves the specified SMTP alert.

Parameters:

  • id —

    The identifier of the site.

  • alert_id —

    The identifier of the alert.

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

    the optional parameters

Returns:



2428
2429
2430
2431
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 2428

def get_site_smtp_alert(site_idte_id, alert_id, opts = {})
  data, _status_code, _headers = get_site_smtp_alert_with_http_info(site_idte_id, alert_id, opts)
  data
end

#get_site_smtp_alert_with_http_info(site_idte_id, alert_id, opts = {}) ⇒ Array<(SmtpAlert, Integer, Hash)>

Site SMTP Alert Retrieves the specified SMTP alert.

Parameters:

  • id —

    The identifier of the site.

  • alert_id —

    The identifier of the alert.

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

    the optional parameters

Returns:

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

    SmtpAlert data, response status code and response headers



2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 2439

def get_site_smtp_alert_with_http_info(site_idte_id, alert_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SiteApi.get_site_smtp_alert ...'
  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 SiteApi.get_site_smtp_alert"
  end
  # verify the required parameter 'alert_id' is set
  if @api_client.config.client_side_validation && alert_id.nil?
    fail ArgumentError, "Missing the required parameter 'alert_id' when calling SiteApi.get_site_smtp_alert"
  end
  # resource path
  local_var_path = '/api/3/sites/{id}/alerts/smtp/{alertId}'.sub('{' + 'id' + '}', site_idte_id.to_s).sub('{' + 'alertId' + '}', alert_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] || 'SmtpAlert' 

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

#get_site_smtp_alerts(site_idte_id, opts = {}) ⇒ ResourcesSmtpAlert

Site SMTP Alerts Retrieves all SMTP alerts defined in the site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:



2489
2490
2491
2492
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 2489

def get_site_smtp_alerts(site_idte_id, opts = {})
  data, _status_code, _headers = get_site_smtp_alerts_with_http_info(site_idte_id, opts)
  data
end

#get_site_smtp_alerts_with_http_info(site_idte_id, opts = {}) ⇒ Array<(ResourcesSmtpAlert, Integer, Hash)>

Site SMTP Alerts Retrieves all SMTP alerts defined in the site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:

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

    ResourcesSmtpAlert data, response status code and response headers



2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 2499

def get_site_smtp_alerts_with_http_info(site_idte_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SiteApi.get_site_smtp_alerts ...'
  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 SiteApi.get_site_smtp_alerts"
  end
  # resource path
  local_var_path = '/api/3/sites/{id}/alerts/smtp'.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] || 'ResourcesSmtpAlert' 

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

#get_site_snmp_alert(site_idte_id, alert_id, opts = {}) ⇒ SnmpAlert

Site SNMP Alert Retrieves the specified SNMP alert.

Parameters:

  • id —

    The identifier of the site.

  • alert_id —

    The identifier of the alert.

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

    the optional parameters

Returns:



2546
2547
2548
2549
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 2546

def get_site_snmp_alert(site_idte_id, alert_id, opts = {})
  data, _status_code, _headers = get_site_snmp_alert_with_http_info(site_idte_id, alert_id, opts)
  data
end

#get_site_snmp_alert_with_http_info(site_idte_id, alert_id, opts = {}) ⇒ Array<(SnmpAlert, Integer, Hash)>

Site SNMP Alert Retrieves the specified SNMP alert.

Parameters:

  • id —

    The identifier of the site.

  • alert_id —

    The identifier of the alert.

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

    the optional parameters

Returns:

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

    SnmpAlert data, response status code and response headers



2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 2557

def get_site_snmp_alert_with_http_info(site_idte_id, alert_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SiteApi.get_site_snmp_alert ...'
  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 SiteApi.get_site_snmp_alert"
  end
  # verify the required parameter 'alert_id' is set
  if @api_client.config.client_side_validation && alert_id.nil?
    fail ArgumentError, "Missing the required parameter 'alert_id' when calling SiteApi.get_site_snmp_alert"
  end
  # resource path
  local_var_path = '/api/3/sites/{id}/alerts/snmp/{alertId}'.sub('{' + 'id' + '}', site_idte_id.to_s).sub('{' + 'alertId' + '}', alert_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] || 'SnmpAlert' 

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

#get_site_snmp_alerts(site_idte_id, opts = {}) ⇒ ResourcesSnmpAlert

Site SNMP Alerts Retrieves all SNMP alerts defined in the site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:



2607
2608
2609
2610
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 2607

def get_site_snmp_alerts(site_idte_id, opts = {})
  data, _status_code, _headers = get_site_snmp_alerts_with_http_info(site_idte_id, opts)
  data
end

#get_site_snmp_alerts_with_http_info(site_idte_id, opts = {}) ⇒ Array<(ResourcesSnmpAlert, Integer, Hash)>

Site SNMP Alerts Retrieves all SNMP alerts defined in the site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:

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

    ResourcesSnmpAlert data, response status code and response headers



2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 2617

def get_site_snmp_alerts_with_http_info(site_idte_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SiteApi.get_site_snmp_alerts ...'
  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 SiteApi.get_site_snmp_alerts"
  end
  # resource path
  local_var_path = '/api/3/sites/{id}/alerts/snmp'.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] || 'ResourcesSnmpAlert' 

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

#get_site_syslog_alert(site_idte_id, alert_id, opts = {}) ⇒ SyslogAlert

Site Syslog Alert Retrieves the specified Syslog alert.

Parameters:

  • id —

    The identifier of the site.

  • alert_id —

    The identifier of the alert.

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

    the optional parameters

Returns:



2664
2665
2666
2667
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 2664

def get_site_syslog_alert(site_idte_id, alert_id, opts = {})
  data, _status_code, _headers = get_site_syslog_alert_with_http_info(site_idte_id, alert_id, opts)
  data
end

#get_site_syslog_alert_with_http_info(site_idte_id, alert_id, opts = {}) ⇒ Array<(SyslogAlert, Integer, Hash)>

Site Syslog Alert Retrieves the specified Syslog alert.

Parameters:

  • id —

    The identifier of the site.

  • alert_id —

    The identifier of the alert.

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

    the optional parameters

Returns:

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

    SyslogAlert data, response status code and response headers



2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 2675

def get_site_syslog_alert_with_http_info(site_idte_id, alert_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SiteApi.get_site_syslog_alert ...'
  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 SiteApi.get_site_syslog_alert"
  end
  # verify the required parameter 'alert_id' is set
  if @api_client.config.client_side_validation && alert_id.nil?
    fail ArgumentError, "Missing the required parameter 'alert_id' when calling SiteApi.get_site_syslog_alert"
  end
  # resource path
  local_var_path = '/api/3/sites/{id}/alerts/syslog/{alertId}'.sub('{' + 'id' + '}', site_idte_id.to_s).sub('{' + 'alertId' + '}', alert_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] || 'SyslogAlert' 

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

#get_site_syslog_alerts(site_idte_id, opts = {}) ⇒ ResourcesSyslogAlert

Site Syslog Alerts Retrieves all Syslog alerts defined in the site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:



2725
2726
2727
2728
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 2725

def get_site_syslog_alerts(site_idte_id, opts = {})
  data, _status_code, _headers = get_site_syslog_alerts_with_http_info(site_idte_id, opts)
  data
end

#get_site_syslog_alerts_with_http_info(site_idte_id, opts = {}) ⇒ Array<(ResourcesSyslogAlert, Integer, Hash)>

Site Syslog Alerts Retrieves all Syslog alerts defined in the site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:

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

    ResourcesSyslogAlert data, response status code and response headers



2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 2735

def get_site_syslog_alerts_with_http_info(site_idte_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SiteApi.get_site_syslog_alerts ...'
  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 SiteApi.get_site_syslog_alerts"
  end
  # resource path
  local_var_path = '/api/3/sites/{id}/alerts/syslog'.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] || 'ResourcesSyslogAlert' 

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

#get_site_tags(site_idte_id, opts = {}) ⇒ ResourcesTag

Site Tags Retrieves the list of tags added to the sites.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:



2781
2782
2783
2784
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 2781

def get_site_tags(site_idte_id, opts = {})
  data, _status_code, _headers = get_site_tags_with_http_info(site_idte_id, opts)
  data
end

#get_site_tags_with_http_info(site_idte_id, opts = {}) ⇒ Array<(ResourcesTag, Integer, Hash)>

Site Tags Retrieves the list of tags added to the sites.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:

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

    ResourcesTag data, response status code and response headers



2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 2791

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

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

#get_site_users(site_idte_id, opts = {}) ⇒ ResourcesUser

Site Users Access Retrieve the list of non-administrator users that have access to the site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:



2837
2838
2839
2840
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 2837

def get_site_users(site_idte_id, opts = {})
  data, _status_code, _headers = get_site_users_with_http_info(site_idte_id, opts)
  data
end

#get_site_users_with_http_info(site_idte_id, opts = {}) ⇒ Array<(ResourcesUser, Integer, Hash)>

Site Users Access Retrieve the list of non-administrator users that have access to the site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:

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

    ResourcesUser data, response status code and response headers



2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 2847

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

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

#get_site_with_http_info(site_idte_id, opts = {}) ⇒ Array<(Site, Integer, Hash)>

Site Retrieves the site with the specified identifier.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:

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

    Site data, response status code and response headers



1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 1688

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

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

#get_sites(opts = {}) ⇒ PageOfSite

Sites Retrieves a paged resource of accessible sites.

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:



2895
2896
2897
2898
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 2895

def get_sites(opts = {})
  data, _status_code, _headers = get_sites_with_http_info(opts)
  data
end

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

Sites Retrieves a paged resource of accessible sites.

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:

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

    PageOfSite data, response status code and response headers



2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 2907

def get_sites_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SiteApi.get_sites ...'
  end
  # resource path
  local_var_path = '/api/3/sites'

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

#get_web_auth_html_forms(site_idte_id, opts = {}) ⇒ ResourcesWebFormAuthentication

Web Authentication HTML Forms Retrieves all HTML form authentications configured in the site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:



2952
2953
2954
2955
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 2952

def get_web_auth_html_forms(site_idte_id, opts = {})
  data, _status_code, _headers = get_web_auth_html_forms_with_http_info(site_idte_id, opts)
  data
end

#get_web_auth_html_forms_with_http_info(site_idte_id, opts = {}) ⇒ Array<(ResourcesWebFormAuthentication, Integer, Hash)>

Web Authentication HTML Forms Retrieves all HTML form authentications configured in the site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:



2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 2962

def get_web_auth_html_forms_with_http_info(site_idte_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SiteApi.get_web_auth_html_forms ...'
  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 SiteApi.get_web_auth_html_forms"
  end
  # resource path
  local_var_path = '/api/3/sites/{id}/web_authentication/html_forms'.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] || 'ResourcesWebFormAuthentication' 

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

#get_web_auth_http_headers(site_idte_id, opts = {}) ⇒ ResourcesWebHeaderAuthentication

Web Authentication HTTP Headers Retrieves all HTTP header authentications configured in the site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:



3008
3009
3010
3011
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 3008

def get_web_auth_http_headers(site_idte_id, opts = {})
  data, _status_code, _headers = get_web_auth_http_headers_with_http_info(site_idte_id, opts)
  data
end

#get_web_auth_http_headers_with_http_info(site_idte_id, opts = {}) ⇒ Array<(ResourcesWebHeaderAuthentication, Integer, Hash)>

Web Authentication HTTP Headers Retrieves all HTTP header authentications configured in the site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:



3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 3018

def get_web_auth_http_headers_with_http_info(site_idte_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SiteApi.get_web_auth_http_headers ...'
  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 SiteApi.get_web_auth_http_headers"
  end
  # resource path
  local_var_path = '/api/3/sites/{id}/web_authentication/http_headers'.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] || 'ResourcesWebHeaderAuthentication' 

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

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

Site Excluded Asset Groups Removes all excluded asset groups from the specified static site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:



3064
3065
3066
3067
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 3064

def remove_all_excluded_asset_groups(site_idte_id, opts = {})
  data, _status_code, _headers = remove_all_excluded_asset_groups_with_http_info(site_idte_id, opts)
  data
end

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

Site Excluded Asset Groups Removes all excluded asset groups from the specified static site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:

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

    Links data, response status code and response headers



3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 3074

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

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

Site Included Asset Groups Removes all included asset groups from the specified static site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:



3120
3121
3122
3123
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 3120

def remove_all_included_asset_groups(site_idte_id, opts = {})
  data, _status_code, _headers = remove_all_included_asset_groups_with_http_info(site_idte_id, opts)
  data
end

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

Site Included Asset Groups Removes all included asset groups from the specified static site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:

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

    Links data, response status code and response headers



3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 3130

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

#remove_asset_from_site(site_idte_id, asset_id, opts = {}) ⇒ Links

Site Asset Removes an asset from a site. The asset will only be deleted if it belongs to no other sites.

Parameters:

  • id —

    The identifier of the site.

  • asset_id —

    The identifier of the asset.

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

    the optional parameters

Returns:



3177
3178
3179
3180
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 3177

def remove_asset_from_site(site_idte_id, asset_id, opts = {})
  data, _status_code, _headers = remove_asset_from_site_with_http_info(site_idte_id, asset_id, opts)
  data
end

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

Site Asset Removes an asset from a site. The asset will only be deleted if it belongs to no other sites.

Parameters:

  • id —

    The identifier of the site.

  • asset_id —

    The identifier of the asset.

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

    the optional parameters

Returns:

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

    Links data, response status code and response headers



3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 3188

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

#remove_excluded_asset_group(site_idte_id, asset_group_id, opts = {}) ⇒ Links

Site Excluded Asset Group Removes the specified asset group from the excluded asset groups configured in the static site.

Parameters:

  • id —

    The identifier of the site.

  • asset_group_id —

    The identifier of the asset group.

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

    the optional parameters

Returns:



3239
3240
3241
3242
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 3239

def remove_excluded_asset_group(site_idte_id, asset_group_id, opts = {})
  data, _status_code, _headers = remove_excluded_asset_group_with_http_info(site_idte_id, asset_group_id, opts)
  data
end

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

Site Excluded Asset Group Removes the specified asset group from the excluded asset groups configured in the static site.

Parameters:

  • id —

    The identifier of the site.

  • asset_group_id —

    The identifier of the asset group.

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

    the optional parameters

Returns:

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

    Links data, response status code and response headers



3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 3250

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

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

Site Excluded Targets Removes one or more addresses from the site’s list of excluded scan targets.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

  • :body (Array<String>) —

    List of address to remove from the sites excluded scan targets. Each address is a string that can represent either a hostname, ipv4 address, ipv4 address range, ipv6 address, or CIDR notation.

Returns:



3301
3302
3303
3304
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 3301

def remove_excluded_targets(site_idte_id, opts = {})
  data, _status_code, _headers = remove_excluded_targets_with_http_info(site_idte_id, opts)
  data
end

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

Site Excluded Targets Removes one or more addresses from the site&#x27;s list of excluded scan targets.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

  • :body (Array<String>) —

    List of address to remove from the sites excluded scan targets. Each address is a string that can represent either a hostname, ipv4 address, ipv4 address range, ipv6 address, or CIDR notation.

Returns:

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

    Links data, response status code and response headers



3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 3312

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

#remove_included_asset_group(site_idte_id, asset_group_id, opts = {}) ⇒ Links

Site Included Asset Group Removes the specified asset group from the included asset groups configured in the static site.

Parameters:

  • id —

    The identifier of the site.

  • asset_group_id —

    The identifier of the asset group.

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

    the optional parameters

Returns:



3361
3362
3363
3364
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 3361

def remove_included_asset_group(site_idte_id, asset_group_id, opts = {})
  data, _status_code, _headers = remove_included_asset_group_with_http_info(site_idte_id, asset_group_id, opts)
  data
end

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

Site Included Asset Group Removes the specified asset group from the included asset groups configured in the static site.

Parameters:

  • id —

    The identifier of the site.

  • asset_group_id —

    The identifier of the asset group.

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

    the optional parameters

Returns:

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

    Links data, response status code and response headers



3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 3372

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

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

Site Included Targets Removes one or more addresses from the site’s list of included scan targets.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

  • :body (Array<String>) —

    List of address to remove from the sites included scan targets. Each address is a string that can represent either a hostname, ipv4 address, ipv4 address range, ipv6 address, or CIDR notation.

Returns:



3423
3424
3425
3426
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 3423

def remove_included_targets(site_idte_id, opts = {})
  data, _status_code, _headers = remove_included_targets_with_http_info(site_idte_id, opts)
  data
end

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

Site Included Targets Removes one or more addresses from the site&#x27;s list of included scan targets.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

  • :body (Array<String>) —

    List of address to remove from the sites included scan targets. Each address is a string that can represent either a hostname, ipv4 address, ipv4 address range, ipv6 address, or CIDR notation.

Returns:

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

    Links data, response status code and response headers



3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 3434

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

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

Site Assets Removes all assets from the specified site. Assets will be deleted entirely from the Security Console if either Asset Linking is disabled or if Asset Linking is enabled and the asset only existed in this site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:



3482
3483
3484
3485
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 3482

def remove_site_assets(site_idte_id, opts = {})
  data, _status_code, _headers = remove_site_assets_with_http_info(site_idte_id, opts)
  data
end

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

Site Assets Removes all assets from the specified site. Assets will be deleted entirely from the Security Console if either Asset Linking is disabled or if Asset Linking is enabled and the asset only existed in this site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:

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

    Links data, response status code and response headers



3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 3492

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

#remove_site_tag(site_idte_id, tag_id, opts = {}) ⇒ Links

Site Tag Removes the specified tag from the site’s tags.

Parameters:

  • id —

    The identifier of the site.

  • tag_id —

    The identifier of the tag.

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

    the optional parameters

Returns:



3539
3540
3541
3542
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 3539

def remove_site_tag(site_idte_id, tag_id, opts = {})
  data, _status_code, _headers = remove_site_tag_with_http_info(site_idte_id, tag_id, opts)
  data
end

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

Site Tag Removes the specified tag from the site&#x27;s tags.

Parameters:

  • id —

    The identifier of the site.

  • tag_id —

    The identifier of the tag.

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

    the optional parameters

Returns:

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

    Links data, response status code and response headers



3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 3550

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

#remove_site_user(site_idte_id, user_id, opts = {}) ⇒ Links

Site User Access Removes the specified user from the site’s access list.

Parameters:

  • id —

    The identifier of the site.

  • user_id —

    The identifier of the user.

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

    the optional parameters

Returns:



3601
3602
3603
3604
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 3601

def remove_site_user(site_idte_id, user_id, opts = {})
  data, _status_code, _headers = remove_site_user_with_http_info(site_idte_id, user_id, opts)
  data
end

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

Site User Access Removes the specified user from the site&#x27;s access list.

Parameters:

  • id —

    The identifier of the site.

  • user_id —

    The identifier of the user.

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

    the optional parameters

Returns:

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

    Links data, response status code and response headers



3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 3612

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

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

Site Scan Credentials Updates multiple site credentials.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

  • :body (Array<SiteCredential>) —

    A list of site credentials resources.

Returns:



3663
3664
3665
3666
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 3663

def set_site_credentials(site_idte_id, opts = {})
  data, _status_code, _headers = set_site_credentials_with_http_info(site_idte_id, opts)
  data
end

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

Site Scan Credentials Updates multiple site credentials.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

  • :body (Array<SiteCredential>) —

    A list of site credentials resources.

Returns:

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

    Links data, response status code and response headers



3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 3674

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

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

Site Discovery Connection Updates the discovery connection assigned to the site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

  • :body (Integer) —

    The identifier of the discovery connection.

Returns:



3723
3724
3725
3726
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 3723

def set_site_discovery_connection(site_idte_id, opts = {})
  data, _status_code, _headers = set_site_discovery_connection_with_http_info(site_idte_id, opts)
  data
end

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

Site Discovery Connection Updates the discovery connection assigned to the site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

  • :body (Integer) —

    The identifier of the discovery connection.

Returns:

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

    Links data, response status code and response headers



3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 3734

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

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

Site Discovery Search Criteria Update the search criteria of the dynamic site.

Parameters:

  • body —

    param1

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:



3783
3784
3785
3786
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 3783

def set_site_discovery_search_criteria(body, site_idte_id, opts = {})
  data, _status_code, _headers = set_site_discovery_search_criteria_with_http_info(body, site_idte_id, opts)
  data
end

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

Site Discovery Search Criteria Update the search criteria of the dynamic site.

Parameters:

  • body —

    param1

  • id —

    The identifier of the site.

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

    the optional parameters

Returns:

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

    Links data, response status code and response headers



3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 3794

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

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

Site Scan Engine Updates the assigned scan engine to the site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

  • :body (Integer) —

    The identifier of the scan engine.

Returns:



3847
3848
3849
3850
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 3847

def set_site_scan_engine(site_idte_id, opts = {})
  data, _status_code, _headers = set_site_scan_engine_with_http_info(site_idte_id, opts)
  data
end

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

Site Scan Engine Updates the assigned scan engine to the site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

  • :body (Integer) —

    The identifier of the scan engine.

Returns:

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

    Links data, response status code and response headers



3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 3858

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

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

Site Scan Schedules Updates all scan schedules for the specified site in a single request using the array of resources defined in the request body.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

  • :body (Array<ScanSchedule>) —

    Array of resources for updating all scan schedules defined in the site. Scan schedules defined in the site that are omitted from this request will be deleted from the site.

Returns:



3907
3908
3909
3910
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 3907

def set_site_scan_schedules(site_idte_id, opts = {})
  data, _status_code, _headers = set_site_scan_schedules_with_http_info(site_idte_id, opts)
  data
end

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

Site Scan Schedules Updates all scan schedules for the specified site in a single request using the array of resources defined in the request body.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

  • :body (Array<ScanSchedule>) —

    Array of resources for updating all scan schedules defined in the site. Scan schedules defined in the site that are omitted from this request will be deleted from the site.

Returns:

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

    Links data, response status code and response headers



3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 3918

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

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

Site Scan Template Updates the assigned scan template to the site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

  • :body (String) —

    The identifier of the scan template.

Returns:



3967
3968
3969
3970
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 3967

def set_site_scan_template(site_idte_id, opts = {})
  data, _status_code, _headers = set_site_scan_template_with_http_info(site_idte_id, opts)
  data
end

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

Site Scan Template Updates the assigned scan template to the site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

  • :body (String) —

    The identifier of the scan template.

Returns:

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

    Links data, response status code and response headers



3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 3978

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

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

Site SMTP Alerts Updates all SMTP alerts for the specified site in a single request using the array of resources defined in the request body.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

  • :body (Array<SmtpAlert>) —

    Array of resources for updating all SMTP alerts defined in the site. Alerts defined in the site that are omitted from this request will be deleted from the site.

Returns:



4027
4028
4029
4030
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 4027

def set_site_smtp_alerts(site_idte_id, opts = {})
  data, _status_code, _headers = set_site_smtp_alerts_with_http_info(site_idte_id, opts)
  data
end

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

Site SMTP Alerts Updates all SMTP alerts for the specified site in a single request using the array of resources defined in the request body.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

  • :body (Array<SmtpAlert>) —

    Array of resources for updating all SMTP alerts defined in the site. Alerts defined in the site that are omitted from this request will be deleted from the site.

Returns:

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

    Links data, response status code and response headers



4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 4038

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

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

Site SNMP Alerts Updates all SNMP alerts for the specified site in a single request using the array of resources defined in the request body.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

  • :body (Array<SnmpAlert>) —

    Array of resources for updating all SNMP alerts defined in the site. Alerts defined in the site that are omitted from this request will be deleted from the site.

Returns:



4087
4088
4089
4090
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 4087

def set_site_snmp_alerts(site_idte_id, opts = {})
  data, _status_code, _headers = set_site_snmp_alerts_with_http_info(site_idte_id, opts)
  data
end

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

Site SNMP Alerts Updates all SNMP alerts for the specified site in a single request using the array of resources defined in the request body.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

  • :body (Array<SnmpAlert>) —

    Array of resources for updating all SNMP alerts defined in the site. Alerts defined in the site that are omitted from this request will be deleted from the site.

Returns:

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

    Links data, response status code and response headers



4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 4098

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

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

Site Syslog Alerts Updates all Syslog alerts for the specified site in a single request using the array of resources defined in the request body.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

  • :body (Array<SyslogAlert>) —

    Array of resources for updating all Syslog alerts defined in the site. Alerts defined in the site that are omitted from this request will be deleted from the site.

Returns:



4147
4148
4149
4150
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 4147

def set_site_syslog_alerts(site_idte_id, opts = {})
  data, _status_code, _headers = set_site_syslog_alerts_with_http_info(site_idte_id, opts)
  data
end

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

Site Syslog Alerts Updates all Syslog alerts for the specified site in a single request using the array of resources defined in the request body.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

  • :body (Array<SyslogAlert>) —

    Array of resources for updating all Syslog alerts defined in the site. Alerts defined in the site that are omitted from this request will be deleted from the site.

Returns:

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

    Links data, response status code and response headers



4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 4158

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

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

Site Tags Updates the site’s list of tags.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

  • :body (Array<Integer>) —

    A list of tag identifiers to replace the site&#x27;s tags.

Returns:



4207
4208
4209
4210
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 4207

def set_site_tags(site_idte_id, opts = {})
  data, _status_code, _headers = set_site_tags_with_http_info(site_idte_id, opts)
  data
end

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

Site Tags Updates the site&#x27;s list of tags.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

  • :body (Array<Integer>) —

    A list of tag identifiers to replace the site&#x27;s tags.

Returns:

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

    Links data, response status code and response headers



4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 4218

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

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

Site Users Access Updates the site’s access list.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

  • :body (Array<Integer>) —

    A list of user identifiers to replace the site&#x27;s access list.

Returns:



4267
4268
4269
4270
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 4267

def set_site_users(site_idte_id, opts = {})
  data, _status_code, _headers = set_site_users_with_http_info(site_idte_id, opts)
  data
end

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

Site Users Access Updates the site&#x27;s access list.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

  • :body (Array<Integer>) —

    A list of user identifiers to replace the site&#x27;s access list.

Returns:

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

    Links data, response status code and response headers



4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 4278

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

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

Site Excluded Asset Groups Updates the excluded asset groups in a static site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

  • :body (Array<Integer>) —

    Array of asset group identifiers.

Returns:



4327
4328
4329
4330
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 4327

def update_excluded_asset_groups(site_idte_id, opts = {})
  data, _status_code, _headers = update_excluded_asset_groups_with_http_info(site_idte_id, opts)
  data
end

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

Site Excluded Asset Groups Updates the excluded asset groups in a static site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

  • :body (Array<Integer>) —

    Array of asset group identifiers.

Returns:

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

    Links data, response status code and response headers



4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 4338

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

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

Site Excluded Targets Updates the excluded targets in a static site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

  • :body (Array<String>) —

    List of addresses to be the site&#x27;s new excluded scan targets. Each address is a string that can represent either a hostname, ipv4 address, ipv4 address range, ipv6 address, or CIDR notation.

Returns:



4387
4388
4389
4390
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 4387

def update_excluded_targets(site_idte_id, opts = {})
  data, _status_code, _headers = update_excluded_targets_with_http_info(site_idte_id, opts)
  data
end

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

Site Excluded Targets Updates the excluded targets in a static site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

  • :body (Array<String>) —

    List of addresses to be the site&#x27;s new excluded scan targets. Each address is a string that can represent either a hostname, ipv4 address, ipv4 address range, ipv6 address, or CIDR notation.

Returns:

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

    Links data, response status code and response headers



4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 4398

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

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

Site Included Asset Groups Updates the included asset groups in a static site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

  • :body (Array<Integer>) —

    Array of asset group identifiers.

Returns:



4447
4448
4449
4450
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 4447

def update_included_asset_groups(site_idte_id, opts = {})
  data, _status_code, _headers = update_included_asset_groups_with_http_info(site_idte_id, opts)
  data
end

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

Site Included Asset Groups Updates the included asset groups in a static site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

  • :body (Array<Integer>) —

    Array of asset group identifiers.

Returns:

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

    Links data, response status code and response headers



4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 4458

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

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

Site Included Targets Updates the included targets in a static site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

  • :body (Array<String>) —

    List of addresses to be the site&#x27;s new included scan targets. Each address is a string that can represent either a hostname, ipv4 address, ipv4 address range, ipv6 address, or CIDR notation.

Returns:



4507
4508
4509
4510
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 4507

def update_included_targets(site_idte_id, opts = {})
  data, _status_code, _headers = update_included_targets_with_http_info(site_idte_id, opts)
  data
end

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

Site Included Targets Updates the included targets in a static site.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

  • :body (Array<String>) —

    List of addresses to be the site&#x27;s new included scan targets. Each address is a string that can represent either a hostname, ipv4 address, ipv4 address range, ipv6 address, or CIDR notation.

Returns:

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

    Links data, response status code and response headers



4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 4518

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

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

Site Updates the configuration of the site with the specified identifier.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

Returns:



4567
4568
4569
4570
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 4567

def update_site(site_idte_id, opts = {})
  data, _status_code, _headers = update_site_with_http_info(site_idte_id, opts)
  data
end

#update_site_credential(site_idte_id, credential_id, opts = {}) ⇒ Links

Site Scan Credential Updates the specified site credential.

Parameters:

  • id —

    The identifier of the site.

  • credential_id —

    The identifier of the site credential.

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

    the optional parameters

Options Hash (opts):

  • :body (SiteCredential) —

    The specification of the site credential to update.

Returns:



4628
4629
4630
4631
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 4628

def update_site_credential(site_idte_id, credential_id, opts = {})
  data, _status_code, _headers = update_site_credential_with_http_info(site_idte_id, credential_id, opts)
  data
end

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

Site Scan Credential Updates the specified site credential.

Parameters:

  • id —

    The identifier of the site.

  • credential_id —

    The identifier of the site credential.

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

    the optional parameters

Options Hash (opts):

  • :body (SiteCredential) —

    The specification of the site credential to update.

Returns:

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

    Links data, response status code and response headers



4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 4640

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

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

Site Organization Information Updates the site organization information.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

  • :body (SiteOrganization) —

    Resource for updating the specified site&#x27;s organization information.

Returns:



4693
4694
4695
4696
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 4693

def update_site_organization(site_idte_id, opts = {})
  data, _status_code, _headers = update_site_organization_with_http_info(site_idte_id, opts)
  data
end

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

Site Organization Information Updates the site organization information.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

  • :body (SiteOrganization) —

    Resource for updating the specified site&#x27;s organization information.

Returns:

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

    Links data, response status code and response headers



4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 4704

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

#update_site_scan_schedule(site_idte_id, schedule_id, opts = {}) ⇒ Links

Site Scan Schedule Updates the specified scan schedule.

Parameters:

  • id —

    The identifier of the site.

  • schedule_id —

    The identifier of the scan schedule.

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

    the optional parameters

Options Hash (opts):

  • :body (ScanSchedule) —

    Resource for updating the specified scan schedule.

Returns:



4754
4755
4756
4757
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 4754

def update_site_scan_schedule(site_idte_id, schedule_id, opts = {})
  data, _status_code, _headers = update_site_scan_schedule_with_http_info(site_idte_id, schedule_id, opts)
  data
end

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

Site Scan Schedule Updates the specified scan schedule.

Parameters:

  • id —

    The identifier of the site.

  • schedule_id —

    The identifier of the scan schedule.

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

    the optional parameters

Options Hash (opts):

  • :body (ScanSchedule) —

    Resource for updating the specified scan schedule.

Returns:

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

    Links data, response status code and response headers



4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 4766

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

#update_site_smtp_alert(site_idte_id, alert_id, opts = {}) ⇒ Links

Site SMTP Alert Updates the specified SMTP alert.

Parameters:

  • id —

    The identifier of the site.

  • alert_id —

    The identifier of the alert.

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

    the optional parameters

Options Hash (opts):

  • :body (SmtpAlert) —

    Resource for updating the specified SMTP alert.

Returns:



4820
4821
4822
4823
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 4820

def update_site_smtp_alert(site_idte_id, alert_id, opts = {})
  data, _status_code, _headers = update_site_smtp_alert_with_http_info(site_idte_id, alert_id, opts)
  data
end

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

Site SMTP Alert Updates the specified SMTP alert.

Parameters:

  • id —

    The identifier of the site.

  • alert_id —

    The identifier of the alert.

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

    the optional parameters

Options Hash (opts):

  • :body (SmtpAlert) —

    Resource for updating the specified SMTP alert.

Returns:

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

    Links data, response status code and response headers



4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 4832

def update_site_smtp_alert_with_http_info(site_idte_id, alert_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SiteApi.update_site_smtp_alert ...'
  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 SiteApi.update_site_smtp_alert"
  end
  # verify the required parameter 'alert_id' is set
  if @api_client.config.client_side_validation && alert_id.nil?
    fail ArgumentError, "Missing the required parameter 'alert_id' when calling SiteApi.update_site_smtp_alert"
  end
  # resource path
  local_var_path = '/api/3/sites/{id}/alerts/smtp/{alertId}'.sub('{' + 'id' + '}', site_idte_id.to_s).sub('{' + 'alertId' + '}', alert_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: SiteApi#update_site_smtp_alert\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_site_snmp_alert(site_idte_id, alert_id, opts = {}) ⇒ Links

Site SNMP Alert Updates the specified SNMP alert.

Parameters:

  • id —

    The identifier of the site.

  • alert_id —

    The identifier of the alert.

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

    the optional parameters

Options Hash (opts):

  • :body (SnmpAlert) —

    Resource for updating the specified SNMP alert.

Returns:



4886
4887
4888
4889
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 4886

def update_site_snmp_alert(site_idte_id, alert_id, opts = {})
  data, _status_code, _headers = update_site_snmp_alert_with_http_info(site_idte_id, alert_id, opts)
  data
end

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

Site SNMP Alert Updates the specified SNMP alert.

Parameters:

  • id —

    The identifier of the site.

  • alert_id —

    The identifier of the alert.

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

    the optional parameters

Options Hash (opts):

  • :body (SnmpAlert) —

    Resource for updating the specified SNMP alert.

Returns:

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

    Links data, response status code and response headers



4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 4898

def update_site_snmp_alert_with_http_info(site_idte_id, alert_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SiteApi.update_site_snmp_alert ...'
  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 SiteApi.update_site_snmp_alert"
  end
  # verify the required parameter 'alert_id' is set
  if @api_client.config.client_side_validation && alert_id.nil?
    fail ArgumentError, "Missing the required parameter 'alert_id' when calling SiteApi.update_site_snmp_alert"
  end
  # resource path
  local_var_path = '/api/3/sites/{id}/alerts/snmp/{alertId}'.sub('{' + 'id' + '}', site_idte_id.to_s).sub('{' + 'alertId' + '}', alert_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: SiteApi#update_site_snmp_alert\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_site_syslog_alert(site_idte_id, alert_id, opts = {}) ⇒ Links

Site Syslog Alert Updates the specified Syslog alert.

Parameters:

  • id —

    The identifier of the site.

  • alert_id —

    The identifier of the alert.

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

    the optional parameters

Options Hash (opts):

  • :body (SyslogAlert) —

    Resource for updating the specified Syslog alert.

Returns:



4952
4953
4954
4955
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 4952

def update_site_syslog_alert(site_idte_id, alert_id, opts = {})
  data, _status_code, _headers = update_site_syslog_alert_with_http_info(site_idte_id, alert_id, opts)
  data
end

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

Site Syslog Alert Updates the specified Syslog alert.

Parameters:

  • id —

    The identifier of the site.

  • alert_id —

    The identifier of the alert.

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

    the optional parameters

Options Hash (opts):

  • :body (SyslogAlert) —

    Resource for updating the specified Syslog alert.

Returns:

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

    Links data, response status code and response headers



4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 4964

def update_site_syslog_alert_with_http_info(site_idte_id, alert_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SiteApi.update_site_syslog_alert ...'
  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 SiteApi.update_site_syslog_alert"
  end
  # verify the required parameter 'alert_id' is set
  if @api_client.config.client_side_validation && alert_id.nil?
    fail ArgumentError, "Missing the required parameter 'alert_id' when calling SiteApi.update_site_syslog_alert"
  end
  # resource path
  local_var_path = '/api/3/sites/{id}/alerts/syslog/{alertId}'.sub('{' + 'id' + '}', site_idte_id.to_s).sub('{' + 'alertId' + '}', alert_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: SiteApi#update_site_syslog_alert\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Site Updates the configuration of the site with the specified identifier.

Parameters:

  • id —

    The identifier of the site.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Links data, response status code and response headers



4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/site_api.rb', line 4578

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