Class: SwaggerClient::AssetGroupApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AssetGroupApi

Returns a new instance of AssetGroupApi.



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

def api_client
  @api_client
end

Instance Method Details

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

Resources and operations for managing asset groups. Adds a tag to an asset group.

Parameters:

  • id —

    The identifier of the asset group.

  • tag_id —

    The identifier of the tag.

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

    the optional parameters

Returns:



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

def add_asset_group_tag(site_idte_id, tag_id, opts = {})
  data, _status_code, _headers = add_asset_group_tag_with_http_info(site_idte_id, tag_id, opts)
  data
end

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

Resources and operations for managing asset groups. Adds a tag to an asset group.

Parameters:

  • id —

    The identifier of the asset group.

  • 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



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

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

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

Asset Group User Grants a user with sufficient privileges access to the asset group.

Parameters:

  • id —

    The identifier of the asset group.

  • user_id —

    The identifier of the user.

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

    the optional parameters

Returns:



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

def add_asset_group_user(site_idte_id, user_id, opts = {})
  data, _status_code, _headers = add_asset_group_user_with_http_info(site_idte_id, user_id, opts)
  data
end

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

Asset Group User Grants a user with sufficient privileges access to the asset group.

Parameters:

  • id —

    The identifier of the asset group.

  • 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



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
139
140
141
142
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/asset_group_api.rb', line 98

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

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

Asset Group Asset Adds an asset to a static asset group.

Parameters:

  • id —

    The identifier of the asset group.

  • asset_id —

    The identifier of the asset.

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

    the optional parameters

Returns:



149
150
151
152
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/asset_group_api.rb', line 149

def add_asset_to_asset_group(site_idte_id, asset_id, opts = {})
  data, _status_code, _headers = add_asset_to_asset_group_with_http_info(site_idte_id, asset_id, opts)
  data
end

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

Asset Group Asset Adds an asset to a static asset group.

Parameters:

  • id —

    The identifier of the asset group.

  • 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



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

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

#create_asset_group(opts = {}) ⇒ CreatedReferenceAssetGroupIDLink

Asset Groups Creates a new asset group. The ‘searchCriteria` field can be passed no matter what the type of the asset group is. The asset group `type` changes when the assets are refreshed. Dynamic asset groups constantly refreshed their membership as assets are scanned whereas static asset groups do not change membership automatically. See the <a href="#section/Responses/SearchCriteria">Search Criteria</a> for more information on using dynamic criteria.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (AssetGroup) —

    The details of the asset group.

Returns:



210
211
212
213
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/asset_group_api.rb', line 210

def create_asset_group(opts = {})
  data, _status_code, _headers = create_asset_group_with_http_info(opts)
  data
end

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

Asset Groups Creates a new asset group. The &#x60;searchCriteria&#x60; field can be passed no matter what the type of the asset group is. The asset group &#x60;type&#x60; changes when the assets are refreshed. Dynamic asset groups constantly refreshed their membership as assets are scanned whereas static asset groups do not change membership automatically. See the &lt;a href&#x3D;&quot;#section/Responses/SearchCriteria&quot;&gt;Search Criteria&lt;/a&gt; for more information on using dynamic criteria.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (AssetGroup) —

    The details of the asset group.

Returns:



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

def create_asset_group_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssetGroupApi.create_asset_group ...'
  end
  # resource path
  local_var_path = '/api/3/asset_groups'

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

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

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

Asset Group Deletes the asset group.

Parameters:

  • id —

    The identifier of the asset group.

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

    the optional parameters

Returns:



264
265
266
267
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/asset_group_api.rb', line 264

def delete_asset_group(site_idte_id, opts = {})
  data, _status_code, _headers = delete_asset_group_with_http_info(site_idte_id, opts)
  data
end

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

Asset Group Deletes the asset group.

Parameters:

  • 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



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
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/asset_group_api.rb', line 274

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

#get_agents(opts = {}) ⇒ PageOfAgent

Agents Returns the details for all agents.

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:



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

def get_agents(opts = {})
  data, _status_code, _headers = get_agents_with_http_info(opts)
  data
end

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

Agents Returns the details for all agents.

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

    PageOfAgent data, response status code and response headers



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

def get_agents_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssetGroupApi.get_agents ...'
  end
  # resource path
  local_var_path = '/api/3/agents'

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

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

#get_asset_group(site_idte_id, opts = {}) ⇒ AssetGroup

Asset Group Returns an asset group.

Parameters:

  • id —

    The identifier of the asset group.

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

    the optional parameters

Returns:



379
380
381
382
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/asset_group_api.rb', line 379

def get_asset_group(site_idte_id, opts = {})
  data, _status_code, _headers = get_asset_group_with_http_info(site_idte_id, opts)
  data
end

#get_asset_group_assets(site_idte_id, opts = {}) ⇒ ReferencesWithAssetIDLink

Asset Group Assets Returns hypermedia links for the assets that belong to an asset group.

Parameters:

  • id —

    The identifier of the asset group.

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

    the optional parameters

Returns:



435
436
437
438
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/asset_group_api.rb', line 435

def get_asset_group_assets(site_idte_id, opts = {})
  data, _status_code, _headers = get_asset_group_assets_with_http_info(site_idte_id, opts)
  data
end

#get_asset_group_assets_with_http_info(site_idte_id, opts = {}) ⇒ Array<(ReferencesWithAssetIDLink, Integer, Hash)>

Asset Group Assets Returns hypermedia links for the assets that belong to an asset group.

Parameters:

  • id —

    The identifier of the asset group.

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

    the optional parameters

Returns:

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

    ReferencesWithAssetIDLink data, response status code and response headers



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
474
475
476
477
478
479
480
481
482
483
484
485
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/asset_group_api.rb', line 445

def get_asset_group_assets_with_http_info(site_idte_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssetGroupApi.get_asset_group_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 AssetGroupApi.get_asset_group_assets"
  end
  # resource path
  local_var_path = '/api/3/asset_groups/{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] || 'ReferencesWithAssetIDLink' 

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

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

Asset Group Search Criteria Returns the search criteria of a dynamic asset group.For a reference of valid search criteria input see the <a href="#operation/getAssetsSearchUsingPOST">Asset Search</a> resource.

Parameters:

  • id —

    The identifier of the asset group.

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

    the optional parameters

Returns:



491
492
493
494
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/asset_group_api.rb', line 491

def get_asset_group_search_criteria(site_idte_id, opts = {})
  data, _status_code, _headers = get_asset_group_search_criteria_with_http_info(site_idte_id, opts)
  data
end

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

Asset Group Search Criteria Returns the search criteria of a dynamic asset group.For a reference of valid search criteria input see the &lt;a href&#x3D;&quot;#operation/getAssetsSearchUsingPOST&quot;&gt;Asset Search&lt;/a&gt; resource.

Parameters:

  • id —

    The identifier of the asset group.

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

    the optional parameters

Returns:

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

    SearchCriteria data, response status code and response headers



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
530
531
532
533
534
535
536
537
538
539
540
541
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/asset_group_api.rb', line 501

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

#get_asset_group_tags(site_idte_id, opts = {}) ⇒ ReferencesWithTagIDLink

Asset Group Tags Returns the tags assigned to an asset group.

Parameters:

  • id —

    The identifier of the asset group.

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

    the optional parameters

Returns:



547
548
549
550
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/asset_group_api.rb', line 547

def get_asset_group_tags(site_idte_id, opts = {})
  data, _status_code, _headers = get_asset_group_tags_with_http_info(site_idte_id, opts)
  data
end

#get_asset_group_tags_with_http_info(site_idte_id, opts = {}) ⇒ Array<(ReferencesWithTagIDLink, Integer, Hash)>

Asset Group Tags Returns the tags assigned to an asset group.

Parameters:

  • id —

    The identifier of the asset group.

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

    the optional parameters

Returns:

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

    ReferencesWithTagIDLink data, response status code and response headers



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
586
587
588
589
590
591
592
593
594
595
596
597
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/asset_group_api.rb', line 557

def get_asset_group_tags_with_http_info(site_idte_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssetGroupApi.get_asset_group_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 AssetGroupApi.get_asset_group_tags"
  end
  # resource path
  local_var_path = '/api/3/asset_groups/{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] || 'ReferencesWithTagIDLink' 

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

#get_asset_group_users(site_idte_id, opts = {}) ⇒ ReferencesWithUserIDLink

Asset Group Users Returns hypermedia links for the users with access to this asset group.

Parameters:

  • id —

    The identifier of the asset group.

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

    the optional parameters

Returns:



603
604
605
606
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/asset_group_api.rb', line 603

def get_asset_group_users(site_idte_id, opts = {})
  data, _status_code, _headers = get_asset_group_users_with_http_info(site_idte_id, opts)
  data
end

#get_asset_group_users_with_http_info(site_idte_id, opts = {}) ⇒ Array<(ReferencesWithUserIDLink, Integer, Hash)>

Asset Group Users Returns hypermedia links for the users with access to this asset group.

Parameters:

  • id —

    The identifier of the asset group.

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

    the optional parameters

Returns:

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

    ReferencesWithUserIDLink data, response status code and response headers



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
646
647
648
649
650
651
652
653
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/asset_group_api.rb', line 613

def get_asset_group_users_with_http_info(site_idte_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssetGroupApi.get_asset_group_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 AssetGroupApi.get_asset_group_users"
  end
  # resource path
  local_var_path = '/api/3/asset_groups/{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] || 'ReferencesWithUserIDLink' 

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

#get_asset_group_with_http_info(site_idte_id, opts = {}) ⇒ Array<(AssetGroup, Integer, Hash)>

Asset Group Returns an asset group.

Parameters:

  • id —

    The identifier of the asset group.

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

    the optional parameters

Returns:

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

    AssetGroup data, response status code and response headers



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

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

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

#get_asset_groups(opts = {}) ⇒ PageOfAssetGroup

Asset Groups Returns all asset groups.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    The type of asset group.

  • :name (String) —

    A search pattern for the name of the asset group. Searches are case-insensitive contains.

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



663
664
665
666
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/asset_group_api.rb', line 663

def get_asset_groups(opts = {})
  data, _status_code, _headers = get_asset_groups_with_http_info(opts)
  data
end

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

Asset Groups Returns all asset groups.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    The type of asset group.

  • :name (String) —

    A search pattern for the name of the asset group. Searches are case-insensitive contains.

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

    PageOfAssetGroup data, response status code and response headers



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
706
707
708
709
710
711
712
713
714
715
716
717
718
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/asset_group_api.rb', line 677

def get_asset_groups_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssetGroupApi.get_asset_groups ...'
  end
  # resource path
  local_var_path = '/api/3/asset_groups'

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

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

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

Asset Group Tags Removes all tag associations from the asset group.

Parameters:

  • id —

    The identifier of the asset group.

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

    the optional parameters

Returns:



724
725
726
727
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/asset_group_api.rb', line 724

def remove_all_asset_group_tags(site_idte_id, opts = {})
  data, _status_code, _headers = remove_all_asset_group_tags_with_http_info(site_idte_id, opts)
  data
end

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

Asset Group Tags Removes all tag associations from the asset group.

Parameters:

  • 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



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
768
769
770
771
772
773
774
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/asset_group_api.rb', line 734

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

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

Asset Group Assets Removes the assets from the given static asset group.

Parameters:

  • id —

    The identifier of the asset group.

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

    the optional parameters

Returns:



780
781
782
783
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/asset_group_api.rb', line 780

def remove_all_assets_from_asset_group(site_idte_id, opts = {})
  data, _status_code, _headers = remove_all_assets_from_asset_group_with_http_info(site_idte_id, opts)
  data
end

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

Asset Group Assets Removes the assets from the given static asset group.

Parameters:

  • 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



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

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

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

Asset Group Asset Removes an asset from an asset group.

Parameters:

  • id —

    The identifier of the asset group.

  • asset_id —

    The identifier of the asset.

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

    the optional parameters

Returns:



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

def remove_asset_from_asset_group(site_idte_id, asset_id, opts = {})
  data, _status_code, _headers = remove_asset_from_asset_group_with_http_info(site_idte_id, asset_id, opts)
  data
end

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

Asset Group Asset Removes an asset from an asset group.

Parameters:

  • id —

    The identifier of the asset group.

  • 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



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

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

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

Resources and operations for managing asset groups. Removes a tag from an asset group.

Parameters:

  • id —

    The identifier of the asset group.

  • tag_id —

    The identifier of the tag.

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

    the optional parameters

Returns:



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

def remove_asset_group_tag(site_idte_id, tag_id, opts = {})
  data, _status_code, _headers = remove_asset_group_tag_with_http_info(site_idte_id, tag_id, opts)
  data
end

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

Resources and operations for managing asset groups. Removes a tag from an asset group.

Parameters:

  • id —

    The identifier of the asset group.

  • 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



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
951
952
953
954
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/asset_group_api.rb', line 910

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

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

Asset Group User Removes a user’s access from an asset group.

Parameters:

  • id —

    The identifier of the asset group.

  • user_id —

    The identifier of the user.

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

    the optional parameters

Returns:



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

def remove_asset_group_user(site_idte_id, user_id, opts = {})
  data, _status_code, _headers = remove_asset_group_user_with_http_info(site_idte_id, user_id, opts)
  data
end

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

Asset Group User Removes a user&#x27;s access from an asset group.

Parameters:

  • id —

    The identifier of the asset group.

  • 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



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

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

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

Asset Group Search Criteria Updates the search criteria of a dynamic asset group. For a reference of valid search criteria input see the <a href="#operation/getAssetsSearchUsingPOST">Asset Search</a> resource.

Parameters:

  • id —

    The identifier of the asset group.

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

    the optional parameters

Options Hash (opts):

Returns:



1023
1024
1025
1026
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/asset_group_api.rb', line 1023

def set_asset_group_search_criteria(site_idte_id, opts = {})
  data, _status_code, _headers = set_asset_group_search_criteria_with_http_info(site_idte_id, opts)
  data
end

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

Asset Group Search Criteria Updates the search criteria of a dynamic asset group. For a reference of valid search criteria input see the &lt;a href&#x3D;&quot;#operation/getAssetsSearchUsingPOST&quot;&gt;Asset Search&lt;/a&gt; resource.

Parameters:

  • id —

    The identifier of the asset group.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Links data, response status code and response headers



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

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

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

Asset Group Tags Updates the tags of an asset group.

Parameters:

  • id —

    The identifier of the asset group.

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

    the optional parameters

Options Hash (opts):

  • :body (Array<Integer>) —

    The tags to associate to the asset group.

Returns:



1083
1084
1085
1086
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/asset_group_api.rb', line 1083

def set_asset_group_tags(site_idte_id, opts = {})
  data, _status_code, _headers = set_asset_group_tags_with_http_info(site_idte_id, opts)
  data
end

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

Asset Group Tags Updates the tags of an asset group.

Parameters:

  • id —

    The identifier of the asset group.

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

    the optional parameters

Options Hash (opts):

  • :body (Array<Integer>) —

    The tags to associate to the asset group.

Returns:

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

    Links data, response status code and response headers



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
1134
1135
1136
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/asset_group_api.rb', line 1094

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

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

Asset Group Users Grants users with sufficient privileges access to an asset group.

Parameters:

  • id —

    The identifier of the asset group.

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

    the optional parameters

Options Hash (opts):

  • :body (Array<Integer>) —

    The users to grant access to the asset group.

Returns:



1143
1144
1145
1146
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/asset_group_api.rb', line 1143

def set_asset_group_users(site_idte_id, opts = {})
  data, _status_code, _headers = set_asset_group_users_with_http_info(site_idte_id, opts)
  data
end

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

Asset Group Users Grants users with sufficient privileges access to an asset group.

Parameters:

  • id —

    The identifier of the asset group.

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

    the optional parameters

Options Hash (opts):

  • :body (Array<Integer>) —

    The users to grant access to the asset group.

Returns:

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

    Links data, response status code and response headers



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
1194
1195
1196
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/asset_group_api.rb', line 1154

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

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

Asset Group Updates the details of an asset group. See the search criteria endpoint (/search_criteria) for more information about building the search criteria and examples.

Parameters:

  • id —

    The identifier of the asset group.

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

    the optional parameters

Options Hash (opts):

  • :body (AssetGroup) —

    The details of the asset group.

Returns:



1203
1204
1205
1206
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/asset_group_api.rb', line 1203

def update_asset_group(site_idte_id, opts = {})
  data, _status_code, _headers = update_asset_group_with_http_info(site_idte_id, opts)
  data
end

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

Asset Group Assets Updates all the assets that belong to a static asset group.

Parameters:

  • id —

    The identifier of the asset group.

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

    the optional parameters

Options Hash (opts):

  • :body (Array<Integer>) —

    The assets to place in the asset group.

Returns:



1263
1264
1265
1266
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/asset_group_api.rb', line 1263

def update_asset_group_assets(site_idte_id, opts = {})
  data, _status_code, _headers = update_asset_group_assets_with_http_info(site_idte_id, opts)
  data
end

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

Asset Group Assets Updates all the assets that belong to a static asset group.

Parameters:

  • id —

    The identifier of the asset group.

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

    the optional parameters

Options Hash (opts):

  • :body (Array<Integer>) —

    The assets to place in the asset group.

Returns:

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

    Links data, response status code and response headers



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/asset_group_api.rb', line 1274

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

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

Asset Group Updates the details of an asset group. See the search criteria endpoint (/search_criteria) for more information about building the search criteria and examples.

Parameters:

  • id —

    The identifier of the asset group.

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

    the optional parameters

Options Hash (opts):

  • :body (AssetGroup) —

    The details of the asset group.

Returns:

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

    Links data, response status code and response headers



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
1255
1256
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/asset_group_api.rb', line 1214

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