Class: SwaggerClient::TagApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TagApi

Returns a new instance of TagApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_tag(opts = {}) ⇒ ReferenceWithTagIDLink

Tags Creates a new tag.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Tag) —

    The details of the tag.

Returns:



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

def create_tag(opts = {})
  data, _status_code, _headers = create_tag_with_http_info(opts)
  data
end

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

Tags Creates a new tag.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Tag) —

    The details of the tag.

Returns:

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

    ReferenceWithTagIDLink data, response status code and response headers



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

def create_tag_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagApi.create_tag ...'
  end
  # resource path
  local_var_path = '/api/3/tags'

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

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

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

Tag Deletes the tag.

Parameters:

  • id —

    The identifier of the tag.

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

    the optional parameters

Returns:



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

def delete_tag(site_idte_id, opts = {})
  data, _status_code, _headers = delete_tag_with_http_info(site_idte_id, opts)
  data
end

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

Tag Deletes the tag.

Parameters:

  • 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



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

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

#get_tag(site_idte_id, opts = {}) ⇒ Tag

Tag Returns a tag.

Parameters:

  • id —

    The identifier of the tag.

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

    the optional parameters

Returns:



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

def get_tag(site_idte_id, opts = {})
  data, _status_code, _headers = get_tag_with_http_info(site_idte_id, opts)
  data
end

#get_tag_asset_groups(site_idte_id, opts = {}) ⇒ ReferencesWithAssetGroupIDLink

Tag Asset Groups Returns the asset groups associated with the tag.

Parameters:

  • id —

    The identifier of the tag.

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

    the optional parameters

Returns:



190
191
192
193
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/tag_api.rb', line 190

def get_tag_asset_groups(site_idte_id, opts = {})
  data, _status_code, _headers = get_tag_asset_groups_with_http_info(site_idte_id, opts)
  data
end

#get_tag_asset_groups_with_http_info(site_idte_id, opts = {}) ⇒ Array<(ReferencesWithAssetGroupIDLink, Integer, Hash)>

Tag Asset Groups Returns the asset groups associated with the tag.

Parameters:

  • id —

    The identifier of the tag.

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

    the optional parameters

Returns:



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

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

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

#get_tag_search_criteria(site_idte_id, opts = {}) ⇒ SearchCriteria

Tag Search Criteria Returns the search criteria associated with the tag.

Parameters:

  • id —

    The identifier of the tag.

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

    the optional parameters

Returns:



246
247
248
249
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/tag_api.rb', line 246

def get_tag_search_criteria(site_idte_id, opts = {})
  data, _status_code, _headers = get_tag_search_criteria_with_http_info(site_idte_id, opts)
  data
end

#get_tag_search_criteria_with_http_info(site_idte_id, opts = {}) ⇒ Array<(SearchCriteria, Integer, Hash)>

Tag Search Criteria Returns the search criteria associated with the tag.

Parameters:

  • id —

    The identifier of the tag.

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

    the optional parameters

Returns:

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

    SearchCriteria data, response status code and response headers



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

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

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

#get_tag_with_http_info(site_idte_id, opts = {}) ⇒ Array<(Tag, Integer, Hash)>

Tag Returns a tag.

Parameters:

  • id —

    The identifier of the tag.

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

    the optional parameters

Returns:

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

    Tag data, response status code and response headers



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

def get_tag_with_http_info(site_idte_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagApi.get_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 TagApi.get_tag"
  end
  # resource path
  local_var_path = '/api/3/tags/{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] || 'Tag' 

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

#get_tagged_assets(site_idte_id, opts = {}) ⇒ TaggedAssetReferences

Tag Assets Returns the assets tagged with a tag.

Parameters:

  • id —

    The identifier of the tag.

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

    the optional parameters

Returns:



302
303
304
305
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/tag_api.rb', line 302

def get_tagged_assets(site_idte_id, opts = {})
  data, _status_code, _headers = get_tagged_assets_with_http_info(site_idte_id, opts)
  data
end

#get_tagged_assets_with_http_info(site_idte_id, opts = {}) ⇒ Array<(TaggedAssetReferences, Integer, Hash)>

Tag Assets Returns the assets tagged with a tag.

Parameters:

  • id —

    The identifier of the tag.

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

    the optional parameters

Returns:

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

    TaggedAssetReferences data, response status code and response headers



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/tag_api.rb', line 312

def get_tagged_assets_with_http_info(site_idte_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagApi.get_tagged_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 TagApi.get_tagged_assets"
  end
  # resource path
  local_var_path = '/api/3/tags/{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] || 'TaggedAssetReferences' 

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

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

Tag Sites Returns the sites associated with the tag.

Parameters:

  • id —

    The identifier of the tag.

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

    the optional parameters

Returns:



358
359
360
361
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/tag_api.rb', line 358

def get_tagged_sites(site_idte_id, opts = {})
  data, _status_code, _headers = get_tagged_sites_with_http_info(site_idte_id, opts)
  data
end

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

Tag Sites Returns the sites associated with the tag.

Parameters:

  • id —

    The identifier of the tag.

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

    the optional parameters

Returns:

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

    ReferencesWithSiteIDLink data, response status code and response headers



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/tag_api.rb', line 368

def get_tagged_sites_with_http_info(site_idte_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagApi.get_tagged_sites ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && site_idte_id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling TagApi.get_tagged_sites"
  end
  # resource path
  local_var_path = '/api/3/tags/{id}/sites'.sub('{' + 'id' + '}', site_idte_id.to_s)

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

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

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

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

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

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

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

#get_tags(opts = {}) ⇒ PageOfTag

Tags Returns all tags.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :name (String) —

    name

  • :type (String) —

    type

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



418
419
420
421
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/tag_api.rb', line 418

def get_tags(opts = {})
  data, _status_code, _headers = get_tags_with_http_info(opts)
  data
end

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

Tags Returns all tags.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :name (String) —

    name

  • :type (String) —

    type

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

    PageOfTag data, response status code and response headers



432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/tag_api.rb', line 432

def get_tags_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagApi.get_tags ...'
  end
  # resource path
  local_var_path = '/api/3/tags'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  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] || 'PageOfTag' 

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

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

Tag Search Criteria Removes the search criteria associated with the tag.

Parameters:

  • id —

    The identifier of the tag.

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

    the optional parameters

Returns:



479
480
481
482
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/tag_api.rb', line 479

def remove_tag_search_criteria(site_idte_id, opts = {})
  data, _status_code, _headers = remove_tag_search_criteria_with_http_info(site_idte_id, opts)
  data
end

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

Tag Search Criteria Removes the search criteria associated with the tag.

Parameters:

  • 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



489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/tag_api.rb', line 489

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

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

Tag Sites Removes the associations between the tag and the sites.

Parameters:

  • id —

    The identifier of the tag.

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

    the optional parameters

Returns:



535
536
537
538
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/tag_api.rb', line 535

def remove_tagged_sites(site_idte_id, opts = {})
  data, _status_code, _headers = remove_tagged_sites_with_http_info(site_idte_id, opts)
  data
end

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

Tag Sites Removes the associations between the tag and the sites.

Parameters:

  • 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



545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/tag_api.rb', line 545

def remove_tagged_sites_with_http_info(site_idte_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagApi.remove_tagged_sites ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && site_idte_id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling TagApi.remove_tagged_sites"
  end
  # resource path
  local_var_path = '/api/3/tags/{id}/sites'.sub('{' + 'id' + '}', site_idte_id.to_s)

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

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

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

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

  return_type = opts[:return_type] || '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: TagApi#remove_tagged_sites\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Tag Asset Groups Sets the asset groups associated with the tag.

Parameters:

  • id —

    The identifier of the tag.

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

    the optional parameters

Options Hash (opts):

  • :body (Array<Integer>) —

    The asset groups to add to the tag.

Returns:



592
593
594
595
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/tag_api.rb', line 592

def set_tagged_asset_groups(site_idte_id, opts = {})
  data, _status_code, _headers = set_tagged_asset_groups_with_http_info(site_idte_id, opts)
  data
end

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

Tag Asset Groups Sets the asset groups associated with the tag.

Parameters:

  • id —

    The identifier of the tag.

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

    the optional parameters

Options Hash (opts):

  • :body (Array<Integer>) —

    The asset groups to add to the tag.

Returns:

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

    Links data, response status code and response headers



603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/tag_api.rb', line 603

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

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

Tag Sites Sets the sites associated with the tag.

Parameters:

  • id —

    The identifier of the tag.

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

    the optional parameters

Options Hash (opts):

  • :body (Array<Integer>) —

    The sites to add to the tag.

Returns:



652
653
654
655
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/tag_api.rb', line 652

def set_tagged_sites(site_idte_id, opts = {})
  data, _status_code, _headers = set_tagged_sites_with_http_info(site_idte_id, opts)
  data
end

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

Tag Sites Sets the sites associated with the tag.

Parameters:

  • id —

    The identifier of the tag.

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

    the optional parameters

Options Hash (opts):

  • :body (Array<Integer>) —

    The sites to add to the tag.

Returns:

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

    Links data, response status code and response headers



663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/tag_api.rb', line 663

def set_tagged_sites_with_http_info(site_idte_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagApi.set_tagged_sites ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && site_idte_id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling TagApi.set_tagged_sites"
  end
  # resource path
  local_var_path = '/api/3/tags/{id}/sites'.sub('{' + 'id' + '}', site_idte_id.to_s)

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json;charset=UTF-8'])
  # 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: TagApi#set_tagged_sites\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Tag Asset Adds an asset to the tag.

Parameters:

  • id —

    The identifier of the tag.

  • asset_id —

    The identifier of the asset.

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

    the optional parameters

Returns:



712
713
714
715
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/tag_api.rb', line 712

def tag_asset(site_idte_id, asset_id, opts = {})
  data, _status_code, _headers = tag_asset_with_http_info(site_idte_id, asset_id, opts)
  data
end

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

Tag Asset Group Adds an asset group to this tag.

Parameters:

  • id —

    The identifier of the tag.

  • asset_group_id —

    The asset group identifier.

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

    the optional parameters

Returns:



774
775
776
777
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/tag_api.rb', line 774

def tag_asset_group(site_idte_id, asset_group_id, opts = {})
  data, _status_code, _headers = tag_asset_group_with_http_info(site_idte_id, asset_group_id, opts)
  data
end

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

Tag Asset Group Adds an asset group to this tag.

Parameters:

  • id —

    The identifier of the tag.

  • asset_group_id —

    The asset group identifier.

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

    the optional parameters

Returns:

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

    Links data, response status code and response headers



785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/tag_api.rb', line 785

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

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

Tag Asset Adds an asset to the tag.

Parameters:

  • id —

    The identifier of the tag.

  • 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



723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/tag_api.rb', line 723

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

#tag_site(site_idte_id, site_id, opts = {}) ⇒ Links

Tag Site Adds a site to this tag.

Parameters:

  • id —

    The identifier of the tag.

  • site_id —

    The identifier of the site.

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

    the optional parameters

Returns:



836
837
838
839
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/tag_api.rb', line 836

def tag_site(site_idte_id, site_id, opts = {})
  data, _status_code, _headers = tag_site_with_http_info(site_idte_id, site_id, opts)
  data
end

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

Tag Site Adds a site to this tag.

Parameters:

  • id —

    The identifier of the tag.

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



847
848
849
850
851
852
853
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
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/tag_api.rb', line 847

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

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

Tag Asset Groups Removes the associations between the tag and all asset groups.

Parameters:

  • id —

    The identifier of the tag.

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

    the optional parameters

Returns:



897
898
899
900
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/tag_api.rb', line 897

def untag_all_asset_groups(site_idte_id, opts = {})
  data, _status_code, _headers = untag_all_asset_groups_with_http_info(site_idte_id, opts)
  data
end

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

Tag Asset Groups Removes the associations between the tag and all asset groups.

Parameters:

  • 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



907
908
909
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
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/tag_api.rb', line 907

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

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

Tag Asset Removes an asset from the tag. Note: The asset must be added through the asset or tag, if the asset is added using a site, asset group, or search criteria this will not remove the asset.

Parameters:

  • id —

    The identifier of the tag.

  • asset_id —

    The identifier of the asset.

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

    the optional parameters

Returns:



954
955
956
957
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/tag_api.rb', line 954

def untag_asset(site_idte_id, asset_id, opts = {})
  data, _status_code, _headers = untag_asset_with_http_info(site_idte_id, asset_id, opts)
  data
end

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

Tag Asset Group Removes an asset group from this tag.

Parameters:

  • id —

    The identifier of the tag.

  • asset_group_id —

    The asset group identifier.

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

    the optional parameters

Returns:



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

def untag_asset_group(site_idte_id, asset_group_id, opts = {})
  data, _status_code, _headers = untag_asset_group_with_http_info(site_idte_id, asset_group_id, opts)
  data
end

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

Tag Asset Group Removes an asset group from this tag.

Parameters:

  • id —

    The identifier of the tag.

  • asset_group_id —

    The asset group identifier.

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

    the optional parameters

Returns:

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

    Links data, response status code and response headers



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
1069
1070
1071
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/tag_api.rb', line 1027

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

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

Tag Asset Removes an asset from the tag. Note: The asset must be added through the asset or tag, if the asset is added using a site, asset group, or search criteria this will not remove the asset.

Parameters:

  • id —

    The identifier of the tag.

  • 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



965
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
1007
1008
1009
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/tag_api.rb', line 965

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

#untag_site(site_idte_id, site_id, opts = {}) ⇒ Links

Tag Site Removes a site from this tag.

Parameters:

  • id —

    The identifier of the tag.

  • site_id —

    The identifier of the site.

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

    the optional parameters

Returns:



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

def untag_site(site_idte_id, site_id, opts = {})
  data, _status_code, _headers = untag_site_with_http_info(site_idte_id, site_id, opts)
  data
end

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

Tag Site Removes a site from this tag.

Parameters:

  • id —

    The identifier of the tag.

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



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
1131
1132
1133
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/tag_api.rb', line 1089

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

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

Tag Updates the details of a tag. For more information about accepted fields for the tag search criteria see the PUT /search_criteria documentation.

Parameters:

  • id —

    The identifier of the tag.

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

    the optional parameters

Options Hash (opts):

  • :body (Tag) —

    The details of the tag.

Returns:



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

def update_tag(site_idte_id, opts = {})
  data, _status_code, _headers = update_tag_with_http_info(site_idte_id, opts)
  data
end

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

Tag Search Criteria Updates the search criteria associated with the tag. The following table outlines the search criteria fields and the available operators: | Field | Operators | | ———- | —————- | | ip-address | is, is-not, in-range, not-in-range, is-like, not-like | | ip-address-type | in, not-in | | alternate-address-type | in | | host-name | is, is-not, starts-with, ends-with, contains, does-not-contain, is-empty, is-not-empty, is-like, not-like | | host-type | in, not-in | | operating-system | contains, does-not-contain, is-empty, is-not-empty | | software | contains, does-not-contain| | open-ports | is, is-not, in-range | | service-name | contains, does-not-contain | | risk-score | is, is-not, in-range, is-greater-than,is-less-than | | last-scan-date | is-on-or-before, is-on-or-after, is-between, is-earlier-than, is-within-the-last | | vulnerability-assessed | is-on-or-before, is-on-or-after, is-between, is-earlier-than, is-within-the-last | | vulnerability-category | is, is-not, starts-with, ends-with, contains, does-not-contain| | vulnerability-cvss-score | is, is-not, in-range, is-greater-than, is-less-than | | vulnerability-cvss-v3-score | is, is-not, in-range, is-greater-than, is-less-than | | vulnerability-exposures | includes, does not-include | | vulnerability-title | contains, does-not-contain, is, is-not, starts-with, ends-with | | cve | is, is-not, contains, does-not-contain | | cvss-access-complexity | is, is-not | | cvss-authentication-required | is, is-not | | cvss-access-vector | is, is-not | | cvss-availability-impact | is, is-not | | cvss-confidentiality-impact | is, is-not | | cvss-integrity-impact | is, is-not | | cvss-v3-confidentiality-impact | is, is-not | | cvss-v3-integrity-impact | is, is-not | | cvss-v3-availability-impact | is, is-not | | cvss-v3-attack-vector | is, is-not | | cvss-v3-attack-complexity | is, is-not | | cvss-v3-user-interaction | is, is-not | | cvss-v3-privileges-required | is, is-not | | mobile-device-last-sync | is-within-the-last, is-earlier-than | | pci-compliance | is | | site-id | in, not-in | | criticality-tag | is, is-not, is-greater-than, is-less-than, is-applied, is-not-applied | | custom-tag | is, is-not, starts-with, ends-with, contains, does-not-contain, is-applied, is-not-applied | | location-tag | is, is-not, starts-with, ends-with, contains, does-not-contain, is-applied, is-not-applied | | owner-tag | is, is-not, starts-with, ends-with, contains, does-not-contain, is-applied, is-not-applied | | vulnerability-validated-status | are | | vasset-cluster | is, is-not, contains, does-not-contain, starts-with | | vasset-datacenter | is, is-not | | vasset-host name | is, is-not, contains, does-not-contain, starts-with | | vasset-power state | in, not-in | | vasset-resource pool path | contains, does-not-contain | | container-image | is, is-not, starts-with, ends-with, contains, does-not-contain, is-like, not-like | | container-status | is, is-not | | containers | are | The following table outlines the operators and the values associated with them: | Operator | Values | | ——– | —— | | are | A single string property named "value" | | is-between | A number property named "lower" and a number property named "upper" | | contains | A single string property named "value" | | does-not-contain | A single string property named "value" | | is-earlier-than | A single number property named "value" | | ends-with | A single string property named "value" | | is-greater-than | A single number property named "value" | | in | An array property named "values" | | not-in | An array property named "values" | | in-range | A number property named "lower" and a number property named "upper" | | includes | An array property named "values" | | is | A single string property named "value" | | is-not | A single string property named "value" | | is-applied | No value | | is-not-applied | No value | | is-empty | No value | | is-not-empty | No value | | is-less-than | A single number property named "value" | | is-like | A single string property named "value" | | does-not-contain | A single string property named "value" | | not-in-range | A number property named "lower" and a number property named "upper" | | not-like | A single string property named "value" | | is-on-or-after | A single string property named "value", which is the date in ISO8601 format (yyyy-MM-dd) | | is-on-or-before | A single string property named "value", which is the date in ISO8601 format (yyyy-MM-dd) | | starts-with | A single string property named "value" | | is-within-the-last | A single number property named "value" | The following fields have enumerated values: | Field | Acceptable Values | | —– | —————– | | containers | 0=present, 1=not present | | vulnerability-validated-status | 0=present, 1=not present | | pci-compliance | 0=fail, 1=pass | | alternate-address-type | 0=IPv4, 1=IPv6 | | ip-address-type | 0=IPv4, 1=IPv6 | | host-type | 0=Unknown, 1=Guest, 2=Hypervisor, 3=Physical, 4=Mobile | | cvss-access-complexity | L=Low, M=Medium, H=High | | cvss-integrity-impact | N=None, P=Partial, C=Complete | | cvss-confidentiality-impact | N=None, P=Partial, C=Complete | | cvss-availability-impact | N=None, P=Partial, C=Complete | | cvss-access-vector | L=Local, A=Adjacent, N=Network | | cvss-authentication-required | N=None, S=Single, M=Multiple | | cvss-access-complexity | L=Low, M=Medium, H=High | | cvss-v3-confidentiality-impact | N=None, L=Low, H=High | | cvss-v3-integrity-impact | N=None, L=Low, H=High | | cvss-v3-availability-impact | N=None, L=Low, H=High | | cvss-v3-attack-vector | N=Network, A=Adjacent, L=Local, P=Physical | | cvss-v3-attack-complexity | L=Low, H=High | | cvss-v3-user-interaction | N=None, R=Required | | cvss-v3-privileges-required | N=None, L=Low, H=High | | container-status | created, running, paused, restarting, exited, dead, unknown |

Parameters:

  • id —

    The identifier of the tag.

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

    the optional parameters

Options Hash (opts):

Returns:



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

def update_tag_search_criteria(site_idte_id, opts = {})
  data, _status_code, _headers = update_tag_search_criteria_with_http_info(site_idte_id, opts)
  data
end

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

Tag Search Criteria Updates the search criteria associated with the tag. The following table outlines the search criteria fields and the available operators: | Field | Operators | | ———- | —————- | | ip-address | is, is-not, in-range, not-in-range, is-like, not-like | | ip-address-type | in, not-in | | alternate-address-type | in | | host-name | is, is-not, starts-with, ends-with, contains, does-not-contain, is-empty, is-not-empty, is-like, not-like | | host-type | in, not-in | | operating-system | contains, does-not-contain, is-empty, is-not-empty | | software | contains, does-not-contain| | open-ports | is, is-not, in-range | | service-name | contains, does-not-contain | | risk-score | is, is-not, in-range, is-greater-than,is-less-than | | last-scan-date | is-on-or-before, is-on-or-after, is-between, is-earlier-than, is-within-the-last | | vulnerability-assessed | is-on-or-before, is-on-or-after, is-between, is-earlier-than, is-within-the-last | | vulnerability-category | is, is-not, starts-with, ends-with, contains, does-not-contain| | vulnerability-cvss-score | is, is-not, in-range, is-greater-than, is-less-than | | vulnerability-cvss-v3-score | is, is-not, in-range, is-greater-than, is-less-than | | vulnerability-exposures | includes, does not-include | | vulnerability-title | contains, does-not-contain, is, is-not, starts-with, ends-with | | cve | is, is-not, contains, does-not-contain | | cvss-access-complexity | is, is-not | | cvss-authentication-required | is, is-not | | cvss-access-vector | is, is-not | | cvss-availability-impact | is, is-not | | cvss-confidentiality-impact | is, is-not | | cvss-integrity-impact | is, is-not | | cvss-v3-confidentiality-impact | is, is-not | | cvss-v3-integrity-impact | is, is-not | | cvss-v3-availability-impact | is, is-not | | cvss-v3-attack-vector | is, is-not | | cvss-v3-attack-complexity | is, is-not | | cvss-v3-user-interaction | is, is-not | | cvss-v3-privileges-required | is, is-not | | mobile-device-last-sync | is-within-the-last, is-earlier-than | | pci-compliance | is | | site-id | in, not-in | | criticality-tag | is, is-not, is-greater-than, is-less-than, is-applied, is-not-applied | | custom-tag | is, is-not, starts-with, ends-with, contains, does-not-contain, is-applied, is-not-applied | | location-tag | is, is-not, starts-with, ends-with, contains, does-not-contain, is-applied, is-not-applied | | owner-tag | is, is-not, starts-with, ends-with, contains, does-not-contain, is-applied, is-not-applied | | vulnerability-validated-status | are | | vasset-cluster | is, is-not, contains, does-not-contain, starts-with | | vasset-datacenter | is, is-not | | vasset-host name | is, is-not, contains, does-not-contain, starts-with | | vasset-power state | in, not-in | | vasset-resource pool path | contains, does-not-contain | | container-image | is, is-not, starts-with, ends-with, contains, does-not-contain, is-like, not-like | | container-status | is, is-not | | containers | are | The following table outlines the operators and the values associated with them: | Operator | Values | | ——– | —— | | are | A single string property named &quot;value&quot; | | is-between | A number property named &quot;lower&quot; and a number property named &quot;upper&quot; | | contains | A single string property named &quot;value&quot; | | does-not-contain | A single string property named &quot;value&quot; | | is-earlier-than | A single number property named &quot;value&quot; | | ends-with | A single string property named &quot;value&quot; | | is-greater-than | A single number property named &quot;value&quot; | | in | An array property named &quot;values&quot; | | not-in | An array property named &quot;values&quot; | | in-range | A number property named &quot;lower&quot; and a number property named &quot;upper&quot; | | includes | An array property named &quot;values&quot; | | is | A single string property named &quot;value&quot; | | is-not | A single string property named &quot;value&quot; | | is-applied | No value | | is-not-applied | No value | | is-empty | No value | | is-not-empty | No value | | is-less-than | A single number property named &quot;value&quot; | | is-like | A single string property named &quot;value&quot; | | does-not-contain | A single string property named &quot;value&quot; | | not-in-range | A number property named &quot;lower&quot; and a number property named &quot;upper&quot; | | not-like | A single string property named &quot;value&quot; | | is-on-or-after | A single string property named &quot;value&quot;, which is the date in ISO8601 format (yyyy-MM-dd) | | is-on-or-before | A single string property named &quot;value&quot;, which is the date in ISO8601 format (yyyy-MM-dd) | | starts-with | A single string property named &quot;value&quot; | | is-within-the-last | A single number property named &quot;value&quot; | The following fields have enumerated values: | Field | Acceptable Values | | —– | —————– | | containers | 0&#x3D;present, 1&#x3D;not present | | vulnerability-validated-status | 0&#x3D;present, 1&#x3D;not present | | pci-compliance | 0&#x3D;fail, 1&#x3D;pass | | alternate-address-type | 0&#x3D;IPv4, 1&#x3D;IPv6 | | ip-address-type | 0&#x3D;IPv4, 1&#x3D;IPv6 | | host-type | 0&#x3D;Unknown, 1&#x3D;Guest, 2&#x3D;Hypervisor, 3&#x3D;Physical, 4&#x3D;Mobile | | cvss-access-complexity | L&#x3D;Low, M&#x3D;Medium, H&#x3D;High | | cvss-integrity-impact | N&#x3D;None, P&#x3D;Partial, C&#x3D;Complete | | cvss-confidentiality-impact | N&#x3D;None, P&#x3D;Partial, C&#x3D;Complete | | cvss-availability-impact | N&#x3D;None, P&#x3D;Partial, C&#x3D;Complete | | cvss-access-vector | L&#x3D;Local, A&#x3D;Adjacent, N&#x3D;Network | | cvss-authentication-required | N&#x3D;None, S&#x3D;Single, M&#x3D;Multiple | | cvss-access-complexity | L&#x3D;Low, M&#x3D;Medium, H&#x3D;High | | cvss-v3-confidentiality-impact | N&#x3D;None, L&#x3D;Low, H&#x3D;High | | cvss-v3-integrity-impact | N&#x3D;None, L&#x3D;Low, H&#x3D;High | | cvss-v3-availability-impact | N&#x3D;None, L&#x3D;Low, H&#x3D;High | | cvss-v3-attack-vector | N&#x3D;Network, A&#x3D;Adjacent, L&#x3D;Local, P&#x3D;Physical | | cvss-v3-attack-complexity | L&#x3D;Low, H&#x3D;High | | cvss-v3-user-interaction | N&#x3D;None, R&#x3D;Required | | cvss-v3-privileges-required | N&#x3D;None, L&#x3D;Low, H&#x3D;High | | container-status | created, running, paused, restarting, exited, dead, unknown |

Parameters:

  • id —

    The identifier of the tag.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Links data, response status code and response headers



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

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

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

Tag Updates the details of a tag. For more information about accepted fields for the tag search criteria see the PUT /search_criteria documentation.

Parameters:

  • id —

    The identifier of the tag.

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

    the optional parameters

Options Hash (opts):

  • :body (Tag) —

    The details of the tag.

Returns:

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

    Links data, response status code and response headers



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

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