All URIs are relative to https://localhost:3780
Method | HTTP request | Description |
---|---|---|
add_asset_tag | PUT /api/3/assets/{id}/tags/{tagId} | Asset Tag |
create_asset | POST /api/3/sites/{id}/assets | Assets |
delete_asset | DELETE /api/3/assets/{id} | Asset |
find_assets | POST /api/3/assets/search | Asset Search |
get_asset | GET /api/3/assets/{id} | Asset |
get_asset_databases | GET /api/3/assets/{id}/databases | Asset Databases |
get_asset_files | GET /api/3/assets/{id}/files | Asset Files |
get_asset_service | GET /api/3/assets/{id}/services/{protocol}/{port} | Asset Service |
get_asset_service_configurations | GET /api/3/assets/{id}/services/{protocol}/{port}/configurations | Asset Service Configurations |
get_asset_service_databases | GET /api/3/assets/{id}/services/{protocol}/{port}/databases | Asset Service Databases |
get_asset_service_user_groups | GET /api/3/assets/{id}/services/{protocol}/{port}/user_groups | Asset Service User Groups |
get_asset_service_users | GET /api/3/assets/{id}/services/{protocol}/{port}/users | Asset Service Users |
get_asset_service_web_application | GET /api/3/assets/{id}/services/{protocol}/{port}/web_applications/{webApplicationId} | Asset Service Web Application |
get_asset_service_web_applications | GET /api/3/assets/{id}/services/{protocol}/{port}/web_applications | Asset Service Web Applications |
get_asset_services | GET /api/3/assets/{id}/services | Asset Services |
get_asset_software | GET /api/3/assets/{id}/software | Asset Software |
get_asset_tags | GET /api/3/assets/{id}/tags | Asset Tags |
get_asset_user_groups | GET /api/3/assets/{id}/user_groups | Asset User Groups |
get_asset_users | GET /api/3/assets/{id}/users | Asset Users |
get_assets | GET /api/3/assets | Assets |
get_operating_system | GET /api/3/operating_systems/{id} | Operating System |
get_operating_systems | GET /api/3/operating_systems | Operating Systems |
get_software | GET /api/3/software/{id} | Software |
get_softwares | GET /api/3/software | Software |
remove_asset_tag | DELETE /api/3/assets/{id}/tags/{tagId} | Asset Tag |
Links add_asset_tag(id, tag_id)
Asset Tag
Assigns the specified tag to the asset.
# load the gem
require 'rapid7_vm_console'
api_instance = Rapid7VmConsole::AssetApi.new
id = 789 # Integer | The identifier of the asset.
tag_id = 56 # Integer | The identifier of the tag.
begin
#Asset Tag
result = api_instance.add_asset_tag(id, tag_id)
p result
rescue Rapid7VmConsole::ApiError => e
puts "Exception when calling AssetApi->add_asset_tag: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
id | Integer | The identifier of the asset. | |
tag_id | Integer | The identifier of the tag. |
No authorization required
- Content-Type: application/json
- Accept: application/json;charset=UTF-8
CreatedReference create_asset(id, opts)
Assets
Creates or updates an asset with the specified details.
# load the gem
require 'rapid7_vm_console'
api_instance = Rapid7VmConsole::AssetApi.new
id = 56 # Integer | The identifier of the site.
opts = {
asset: Rapid7VmConsole::AssetCreate.new # AssetCreate | The details of the asset being added or updated. The operating system can be specified in one of three ways, with the order of precedence: `\"osFingerprint\"`, `\"os\"`, `\"cpe\"`
}
begin
#Assets
result = api_instance.create_asset(id, opts)
p result
rescue Rapid7VmConsole::ApiError => e
puts "Exception when calling AssetApi->create_asset: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
id | Integer | The identifier of the site. | |
asset | AssetCreate | The details of the asset being added or updated. The operating system can be specified in one of three ways, with the order of precedence: `"osFingerprint"`, `"os"`, `"cpe"` | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json;charset=UTF-8
Links delete_asset(id)
Asset
Deletes the specified asset.
# load the gem
require 'rapid7_vm_console'
api_instance = Rapid7VmConsole::AssetApi.new
id = 789 # Integer | The identifier of the asset.
begin
#Asset
result = api_instance.delete_asset(id)
p result
rescue Rapid7VmConsole::ApiError => e
puts "Exception when calling AssetApi->delete_asset: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
id | Integer | The identifier of the asset. |
No authorization required
- Content-Type: application/json
- Accept: application/json;charset=UTF-8
PageOfAsset find_assets(param1, opts)
Asset Search
Returns all assets for which you have access that match the given search criteria.
# load the gem
require 'rapid7_vm_console'
api_instance = Rapid7VmConsole::AssetApi.new
param1 = Rapid7VmConsole::SearchCriteria.new # SearchCriteria | param1
opts = {
page: 0, # Integer | The index of the page (zero-based) to retrieve.
size: 10, # Integer | The number of records per page to retrieve.
sort: ['sort_example'] # Array<String> | The criteria to sort the records by, in the format: `property[,ASC|DESC]`. The default sort order is ascending. Multiple sort criteria can be specified using multiple sort query parameters.
}
begin
#Asset Search
result = api_instance.find_assets(param1, opts)
p result
rescue Rapid7VmConsole::ApiError => e
puts "Exception when calling AssetApi->find_assets: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
param1 | SearchCriteria | param1 | |
page | Integer | The index of the page (zero-based) to retrieve. | [optional] [default to 0] |
size | Integer | The number of records per page to retrieve. | [optional] [default to 10] |
sort | Array<String> | The criteria to sort the records by, in the format: `property[,ASC | DESC]`. The default sort order is ascending. Multiple sort criteria can be specified using multiple sort query parameters. |
No authorization required
- Content-Type: application/json
- Accept: application/json;charset=UTF-8
Asset get_asset(id)
Asset
Returns the specified asset.
# load the gem
require 'rapid7_vm_console'
api_instance = Rapid7VmConsole::AssetApi.new
id = 789 # Integer | The identifier of the asset.
begin
#Asset
result = api_instance.get_asset(id)
p result
rescue Rapid7VmConsole::ApiError => e
puts "Exception when calling AssetApi->get_asset: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
id | Integer | The identifier of the asset. |
No authorization required
- Content-Type: application/json
- Accept: application/json;charset=UTF-8
ResourcesDatabase get_asset_databases(id)
Asset Databases
Returns the databases enumerated on an asset.
# load the gem
require 'rapid7_vm_console'
api_instance = Rapid7VmConsole::AssetApi.new
id = 789 # Integer | The identifier of the asset.
begin
#Asset Databases
result = api_instance.get_asset_databases(id)
p result
rescue Rapid7VmConsole::ApiError => e
puts "Exception when calling AssetApi->get_asset_databases: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
id | Integer | The identifier of the asset. |
No authorization required
- Content-Type: application/json
- Accept: application/json;charset=UTF-8
ResourcesFile get_asset_files(id)
Asset Files
Returns the files discovered on an asset.
# load the gem
require 'rapid7_vm_console'
api_instance = Rapid7VmConsole::AssetApi.new
id = 789 # Integer | The identifier of the asset.
begin
#Asset Files
result = api_instance.get_asset_files(id)
p result
rescue Rapid7VmConsole::ApiError => e
puts "Exception when calling AssetApi->get_asset_files: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
id | Integer | The identifier of the asset. |
No authorization required
- Content-Type: application/json
- Accept: application/json;charset=UTF-8
Service get_asset_service(id, protocol, port)
Asset Service
Returns the service running a port and protocol on the asset.
# load the gem
require 'rapid7_vm_console'
api_instance = Rapid7VmConsole::AssetApi.new
id = 789 # Integer | The identifier of the asset.
protocol = 'protocol_example' # String | The protocol of the service.
port = 56 # Integer | The port of the service.
begin
#Asset Service
result = api_instance.get_asset_service(id, protocol, port)
p result
rescue Rapid7VmConsole::ApiError => e
puts "Exception when calling AssetApi->get_asset_service: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
id | Integer | The identifier of the asset. | |
protocol | String | The protocol of the service. | |
port | Integer | The port of the service. |
No authorization required
- Content-Type: application/json
- Accept: application/json;charset=UTF-8
ResourcesConfiguration get_asset_service_configurations(id, protocol, port)
Asset Service Configurations
Returns the configuration (properties) of a port and protocol on an asset.
# load the gem
require 'rapid7_vm_console'
api_instance = Rapid7VmConsole::AssetApi.new
id = 789 # Integer | The identifier of the asset.
protocol = 'protocol_example' # String | The protocol of the service.
port = 56 # Integer | The port of the service.
begin
#Asset Service Configurations
result = api_instance.get_asset_service_configurations(id, protocol, port)
p result
rescue Rapid7VmConsole::ApiError => e
puts "Exception when calling AssetApi->get_asset_service_configurations: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
id | Integer | The identifier of the asset. | |
protocol | String | The protocol of the service. | |
port | Integer | The port of the service. |
No authorization required
- Content-Type: application/json
- Accept: application/json;charset=UTF-8
ResourcesDatabase get_asset_service_databases(id, protocol, port)
Asset Service Databases
Returns the databases running on a port and protocol on an asset.
# load the gem
require 'rapid7_vm_console'
api_instance = Rapid7VmConsole::AssetApi.new
id = 789 # Integer | The identifier of the asset.
protocol = 'protocol_example' # String | The protocol of the service.
port = 56 # Integer | The port of the service.
begin
#Asset Service Databases
result = api_instance.get_asset_service_databases(id, protocol, port)
p result
rescue Rapid7VmConsole::ApiError => e
puts "Exception when calling AssetApi->get_asset_service_databases: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
id | Integer | The identifier of the asset. | |
protocol | String | The protocol of the service. | |
port | Integer | The port of the service. |
No authorization required
- Content-Type: application/json
- Accept: application/json;charset=UTF-8
ResourcesGroupAccount get_asset_service_user_groups(id, protocol, port)
Asset Service User Groups
Returns the user groups enumerated on a port and protocol on an asset.
# load the gem
require 'rapid7_vm_console'
api_instance = Rapid7VmConsole::AssetApi.new
id = 789 # Integer | The identifier of the asset.
protocol = 'protocol_example' # String | The protocol of the service.
port = 56 # Integer | The port of the service.
begin
#Asset Service User Groups
result = api_instance.get_asset_service_user_groups(id, protocol, port)
p result
rescue Rapid7VmConsole::ApiError => e
puts "Exception when calling AssetApi->get_asset_service_user_groups: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
id | Integer | The identifier of the asset. | |
protocol | String | The protocol of the service. | |
port | Integer | The port of the service. |
No authorization required
- Content-Type: application/json
- Accept: application/json;charset=UTF-8
ResourcesUserAccount get_asset_service_users(id, protocol, port)
Asset Service Users
Returns the users enumerated on a port and protocol on an asset.
# load the gem
require 'rapid7_vm_console'
api_instance = Rapid7VmConsole::AssetApi.new
id = 789 # Integer | The identifier of the asset.
protocol = 'protocol_example' # String | The protocol of the service.
port = 56 # Integer | The port of the service.
begin
#Asset Service Users
result = api_instance.get_asset_service_users(id, protocol, port)
p result
rescue Rapid7VmConsole::ApiError => e
puts "Exception when calling AssetApi->get_asset_service_users: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
id | Integer | The identifier of the asset. | |
protocol | String | The protocol of the service. | |
port | Integer | The port of the service. |
No authorization required
- Content-Type: application/json
- Accept: application/json;charset=UTF-8
WebApplication get_asset_service_web_application(id, protocol, port, web_application_id)
Asset Service Web Application
Returns a web application running on a port and protocol on an asset.
# load the gem
require 'rapid7_vm_console'
api_instance = Rapid7VmConsole::AssetApi.new
id = 789 # Integer | The identifier of the asset.
protocol = 'protocol_example' # String | The protocol of the service.
port = 56 # Integer | The port of the service.
web_application_id = 789 # Integer | The identifier of the web application.
begin
#Asset Service Web Application
result = api_instance.get_asset_service_web_application(id, protocol, port, web_application_id)
p result
rescue Rapid7VmConsole::ApiError => e
puts "Exception when calling AssetApi->get_asset_service_web_application: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
id | Integer | The identifier of the asset. | |
protocol | String | The protocol of the service. | |
port | Integer | The port of the service. | |
web_application_id | Integer | The identifier of the web application. |
No authorization required
- Content-Type: application/json
- Accept: application/json;charset=UTF-8
ReferencesWithWebApplicationIDLink get_asset_service_web_applications(id, protocol, port)
Asset Service Web Applications
Returns the web applications running on a port and protocol on an asset.
# load the gem
require 'rapid7_vm_console'
api_instance = Rapid7VmConsole::AssetApi.new
id = 789 # Integer | The identifier of the asset.
protocol = 'protocol_example' # String | The protocol of the service.
port = 56 # Integer | The port of the service.
begin
#Asset Service Web Applications
result = api_instance.get_asset_service_web_applications(id, protocol, port)
p result
rescue Rapid7VmConsole::ApiError => e
puts "Exception when calling AssetApi->get_asset_service_web_applications: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
id | Integer | The identifier of the asset. | |
protocol | String | The protocol of the service. | |
port | Integer | The port of the service. |
ReferencesWithWebApplicationIDLink
No authorization required
- Content-Type: application/json
- Accept: application/json;charset=UTF-8
ReferencesWithReferenceWithEndpointIDLinkServiceLink get_asset_services(id)
Asset Services
Returns the services discovered on an asset.
# load the gem
require 'rapid7_vm_console'
api_instance = Rapid7VmConsole::AssetApi.new
id = 789 # Integer | The identifier of the asset.
begin
#Asset Services
result = api_instance.get_asset_services(id)
p result
rescue Rapid7VmConsole::ApiError => e
puts "Exception when calling AssetApi->get_asset_services: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
id | Integer | The identifier of the asset. |
ReferencesWithReferenceWithEndpointIDLinkServiceLink
No authorization required
- Content-Type: application/json
- Accept: application/json;charset=UTF-8
ResourcesSoftware get_asset_software(id)
Asset Software
Returns the software on an asset.
# load the gem
require 'rapid7_vm_console'
api_instance = Rapid7VmConsole::AssetApi.new
id = 789 # Integer | The identifier of the asset.
begin
#Asset Software
result = api_instance.get_asset_software(id)
p result
rescue Rapid7VmConsole::ApiError => e
puts "Exception when calling AssetApi->get_asset_software: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
id | Integer | The identifier of the asset. |
No authorization required
- Content-Type: application/json
- Accept: application/json;charset=UTF-8
ResourcesAssetTag get_asset_tags(id)
Asset Tags
Returns tags assigned to an asset.
# load the gem
require 'rapid7_vm_console'
api_instance = Rapid7VmConsole::AssetApi.new
id = 789 # Integer | The identifier of the asset.
begin
#Asset Tags
result = api_instance.get_asset_tags(id)
p result
rescue Rapid7VmConsole::ApiError => e
puts "Exception when calling AssetApi->get_asset_tags: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
id | Integer | The identifier of the asset. |
No authorization required
- Content-Type: application/json
- Accept: application/json;charset=UTF-8
ResourcesGroupAccount get_asset_user_groups(id)
Asset User Groups
Returns user groups enumerated on an asset.
# load the gem
require 'rapid7_vm_console'
api_instance = Rapid7VmConsole::AssetApi.new
id = 789 # Integer | The identifier of the asset.
begin
#Asset User Groups
result = api_instance.get_asset_user_groups(id)
p result
rescue Rapid7VmConsole::ApiError => e
puts "Exception when calling AssetApi->get_asset_user_groups: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
id | Integer | The identifier of the asset. |
No authorization required
- Content-Type: application/json
- Accept: application/json;charset=UTF-8
ResourcesUserAccount get_asset_users(id)
Asset Users
Returns users enumerated on an asset.
# load the gem
require 'rapid7_vm_console'
api_instance = Rapid7VmConsole::AssetApi.new
id = 789 # Integer | The identifier of the asset.
begin
#Asset Users
result = api_instance.get_asset_users(id)
p result
rescue Rapid7VmConsole::ApiError => e
puts "Exception when calling AssetApi->get_asset_users: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
id | Integer | The identifier of the asset. |
No authorization required
- Content-Type: application/json
- Accept: application/json;charset=UTF-8
PageOfAsset get_assets(opts)
Assets
Returns all assets for which you have access.
# load the gem
require 'rapid7_vm_console'
api_instance = Rapid7VmConsole::AssetApi.new
opts = {
page: 0, # Integer | The index of the page (zero-based) to retrieve.
size: 10, # Integer | The number of records per page to retrieve.
sort: ['sort_example'] # Array<String> | The criteria to sort the records by, in the format: `property[,ASC|DESC]`. The default sort order is ascending. Multiple sort criteria can be specified using multiple sort query parameters.
}
begin
#Assets
result = api_instance.get_assets(opts)
p result
rescue Rapid7VmConsole::ApiError => e
puts "Exception when calling AssetApi->get_assets: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
page | Integer | The index of the page (zero-based) to retrieve. | [optional] [default to 0] |
size | Integer | The number of records per page to retrieve. | [optional] [default to 10] |
sort | Array<String> | The criteria to sort the records by, in the format: `property[,ASC | DESC]`. The default sort order is ascending. Multiple sort criteria can be specified using multiple sort query parameters. |
No authorization required
- Content-Type: application/json
- Accept: application/json;charset=UTF-8
OperatingSystem get_operating_system(id)
Operating System
Returns the details for an operating system.
# load the gem
require 'rapid7_vm_console'
api_instance = Rapid7VmConsole::AssetApi.new
id = 789 # Integer | The identifier of the operating system.
begin
#Operating System
result = api_instance.get_operating_system(id)
p result
rescue Rapid7VmConsole::ApiError => e
puts "Exception when calling AssetApi->get_operating_system: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
id | Integer | The identifier of the operating system. |
No authorization required
- Content-Type: application/json
- Accept: application/json;charset=UTF-8
PageOfOperatingSystem get_operating_systems(opts)
Operating Systems
Returns all operating systems discovered across all assets.
# load the gem
require 'rapid7_vm_console'
api_instance = Rapid7VmConsole::AssetApi.new
opts = {
page: 0, # Integer | The index of the page (zero-based) to retrieve.
size: 10, # Integer | The number of records per page to retrieve.
sort: ['sort_example'] # Array<String> | The criteria to sort the records by, in the format: `property[,ASC|DESC]`. The default sort order is ascending. Multiple sort criteria can be specified using multiple sort query parameters.
}
begin
#Operating Systems
result = api_instance.get_operating_systems(opts)
p result
rescue Rapid7VmConsole::ApiError => e
puts "Exception when calling AssetApi->get_operating_systems: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
page | Integer | The index of the page (zero-based) to retrieve. | [optional] [default to 0] |
size | Integer | The number of records per page to retrieve. | [optional] [default to 10] |
sort | Array<String> | The criteria to sort the records by, in the format: `property[,ASC | DESC]`. The default sort order is ascending. Multiple sort criteria can be specified using multiple sort query parameters. |
No authorization required
- Content-Type: application/json
- Accept: application/json;charset=UTF-8
Software get_software(id)
Software
Returns the details for software.
# load the gem
require 'rapid7_vm_console'
api_instance = Rapid7VmConsole::AssetApi.new
id = 789 # Integer | The identifier of the software.
begin
#Software
result = api_instance.get_software(id)
p result
rescue Rapid7VmConsole::ApiError => e
puts "Exception when calling AssetApi->get_software: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
id | Integer | The identifier of the software. |
No authorization required
- Content-Type: application/json
- Accept: application/json;charset=UTF-8
PageOfSoftware get_softwares(opts)
Software
Returns all software enumerated on any asset.
# load the gem
require 'rapid7_vm_console'
api_instance = Rapid7VmConsole::AssetApi.new
opts = {
page: 0, # Integer | The index of the page (zero-based) to retrieve.
size: 10, # Integer | The number of records per page to retrieve.
sort: ['sort_example'] # Array<String> | The criteria to sort the records by, in the format: `property[,ASC|DESC]`. The default sort order is ascending. Multiple sort criteria can be specified using multiple sort query parameters.
}
begin
#Software
result = api_instance.get_softwares(opts)
p result
rescue Rapid7VmConsole::ApiError => e
puts "Exception when calling AssetApi->get_softwares: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
page | Integer | The index of the page (zero-based) to retrieve. | [optional] [default to 0] |
size | Integer | The number of records per page to retrieve. | [optional] [default to 10] |
sort | Array<String> | The criteria to sort the records by, in the format: `property[,ASC | DESC]`. The default sort order is ascending. Multiple sort criteria can be specified using multiple sort query parameters. |
No authorization required
- Content-Type: application/json
- Accept: application/json;charset=UTF-8
Links remove_asset_tag(id, tag_id)
Asset Tag
Removes the specified tag from the asset's tags.
# load the gem
require 'rapid7_vm_console'
api_instance = Rapid7VmConsole::AssetApi.new
id = 789 # Integer | The identifier of the asset.
tag_id = 56 # Integer | The identifier of the tag.
begin
#Asset Tag
result = api_instance.remove_asset_tag(id, tag_id)
p result
rescue Rapid7VmConsole::ApiError => e
puts "Exception when calling AssetApi->remove_asset_tag: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
id | Integer | The identifier of the asset. | |
tag_id | Integer | The identifier of the tag. |
No authorization required
- Content-Type: application/json
- Accept: application/json;charset=UTF-8