Rapid7VmConsole::VulnerabilityApi

All URIs are relative to https://localhost:3780

Method	HTTP request	Description
get_affected_assets	GET /api/3/vulnerabilities/{id}/assets	Vulnerability Affected Assets
get_exploit	GET /api/3/exploits/{id}	Exploit
get_exploit_vulnerabilities	GET /api/3/exploits/{id}/vulnerabilities	Exploitable Vulnerabilities
get_exploits	GET /api/3/exploits	Exploits
get_malware_kit	GET /api/3/malware_kits/{id}	Malware Kit
get_malware_kit_vulnerabilities	GET /api/3/malware_kits/{id}/vulnerabilities	Malware Kit Vulnerabilities
get_malware_kits	GET /api/3/malware_kits	Malware Kits
get_prerequisite_solutions	GET /api/3/solutions/{id}/prerequisites	Solution Prerequisites
get_solution	GET /api/3/solutions/{id}	Solution
get_solutions	GET /api/3/solutions	Solutions
get_superseded_solutions	GET /api/3/solutions/{id}/supersedes	Superseded Solutions
get_superseding_solutions	GET /api/3/solutions/{id}/superseding	Superseding Solutions
get_vulnerabilities	GET /api/3/vulnerabilities	Vulnerabilities
get_vulnerability	GET /api/3/vulnerabilities/{id}	Vulnerability
get_vulnerability_categories	GET /api/3/vulnerability_categories	Categories
get_vulnerability_category	GET /api/3/vulnerability_categories/{id}	Category
get_vulnerability_category_vulnerabilities	GET /api/3/vulnerability_categories/{id}/vulnerabilities	Category Vulnerabilities
get_vulnerability_exploits	GET /api/3/vulnerabilities/{id}/exploits	Vulnerability Exploits
get_vulnerability_malware_kits	GET /api/3/vulnerabilities/{id}/malware_kits	Vulnerability Malware Kits
get_vulnerability_reference	GET /api/3/vulnerability_references/{id}	Reference
get_vulnerability_reference_vulnerabilities	GET /api/3/vulnerability_references/{id}/vulnerabilities	Reference Vulnerabilities
get_vulnerability_references	GET /api/3/vulnerability_references	References
get_vulnerability_references1	GET /api/3/vulnerabilities/{id}/references	Vulnerability References
get_vulnerability_solutions	GET /api/3/vulnerabilities/{id}/solutions	Vulnerability Solutions

get_affected_assets

ReferencesWithAssetIDLink get_affected_assets(id)

Vulnerability Affected Assets

Get the assets affected by the vulnerability.

Example

# load the gem
require 'rapid7_vm_console'

api_instance = Rapid7VmConsole::VulnerabilityApi.new

id = 'id_example' # String | The identifier of the vulnerability.


begin
  #Vulnerability Affected Assets
  result = api_instance.get_affected_assets(id)
  p result
rescue Rapid7VmConsole::ApiError => e
  puts "Exception when calling VulnerabilityApi->get_affected_assets: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String	The identifier of the vulnerability.

Return type

ReferencesWithAssetIDLink

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

get_exploit

Exploit get_exploit(id)

Exploit

Returns the details for an exploit.

Example

# load the gem
require 'rapid7_vm_console'

api_instance = Rapid7VmConsole::VulnerabilityApi.new

id = 56 # Integer | The identifier of the exploit.


begin
  #Exploit
  result = api_instance.get_exploit(id)
  p result
rescue Rapid7VmConsole::ApiError => e
  puts "Exception when calling VulnerabilityApi->get_exploit: #{e}"
end

Parameters

Name	Type	Description	Notes
id	Integer	The identifier of the exploit.

Return type

Exploit

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

get_exploit_vulnerabilities

ReferencesWithVulnerabilityNaturalIDLink get_exploit_vulnerabilities(id)

Exploitable Vulnerabilities

Returns the vulnerabilities exploitable to a exploit.

Example

# load the gem
require 'rapid7_vm_console'

api_instance = Rapid7VmConsole::VulnerabilityApi.new

id = 56 # Integer | The identifier of the exploit.


begin
  #Exploitable Vulnerabilities
  result = api_instance.get_exploit_vulnerabilities(id)
  p result
rescue Rapid7VmConsole::ApiError => e
  puts "Exception when calling VulnerabilityApi->get_exploit_vulnerabilities: #{e}"
end

Parameters

Name	Type	Description	Notes
id	Integer	The identifier of the exploit.

Return type

ReferencesWithVulnerabilityNaturalIDLink

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

get_exploits

PageOfExploit get_exploits(opts)

Exploits

Returns all known exploits.

Example

# load the gem
require 'rapid7_vm_console'

api_instance = Rapid7VmConsole::VulnerabilityApi.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
  #Exploits
  result = api_instance.get_exploits(opts)
  p result
rescue Rapid7VmConsole::ApiError => e
  puts "Exception when calling VulnerabilityApi->get_exploits: #{e}"
end

Parameters

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.

Return type

PageOfExploit

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

get_malware_kit

MalwareKit get_malware_kit(id)

Malware Kit

Returns the details for a malware kit.

Example

# load the gem
require 'rapid7_vm_console'

api_instance = Rapid7VmConsole::VulnerabilityApi.new

id = 56 # Integer | The identifier of the malware kit.


begin
  #Malware Kit
  result = api_instance.get_malware_kit(id)
  p result
rescue Rapid7VmConsole::ApiError => e
  puts "Exception when calling VulnerabilityApi->get_malware_kit: #{e}"
end

Parameters

Name	Type	Description	Notes
id	Integer	The identifier of the malware kit.

Return type

MalwareKit

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

get_malware_kit_vulnerabilities

ReferencesWithVulnerabilityNaturalIDLink get_malware_kit_vulnerabilities(id)

Malware Kit Vulnerabilities

Returns the vulnerabilities that are susceptible to being attacked by a malware kit.

Example

# load the gem
require 'rapid7_vm_console'

api_instance = Rapid7VmConsole::VulnerabilityApi.new

id = 56 # Integer | The identifier of the malware kit.


begin
  #Malware Kit Vulnerabilities
  result = api_instance.get_malware_kit_vulnerabilities(id)
  p result
rescue Rapid7VmConsole::ApiError => e
  puts "Exception when calling VulnerabilityApi->get_malware_kit_vulnerabilities: #{e}"
end

Parameters

Name	Type	Description	Notes
id	Integer	The identifier of the malware kit.

Return type

ReferencesWithVulnerabilityNaturalIDLink

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

get_malware_kits

PageOfMalwareKit get_malware_kits(opts)

Malware Kits

Returns all known malware kits.

Example

# load the gem
require 'rapid7_vm_console'

api_instance = Rapid7VmConsole::VulnerabilityApi.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
  #Malware Kits
  result = api_instance.get_malware_kits(opts)
  p result
rescue Rapid7VmConsole::ApiError => e
  puts "Exception when calling VulnerabilityApi->get_malware_kits: #{e}"
end

Parameters

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.

Return type

PageOfMalwareKit

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

get_prerequisite_solutions

ReferencesWithSolutionNaturalIDLink get_prerequisite_solutions(id)

Solution Prerequisites

Returns the solutions that must be executed in order for a solution to resolve a vulnerability.

Example

# load the gem
require 'rapid7_vm_console'

api_instance = Rapid7VmConsole::VulnerabilityApi.new

id = 'id_example' # String | The identifier of the solution.


begin
  #Solution Prerequisites
  result = api_instance.get_prerequisite_solutions(id)
  p result
rescue Rapid7VmConsole::ApiError => e
  puts "Exception when calling VulnerabilityApi->get_prerequisite_solutions: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String	The identifier of the solution.

Return type

ReferencesWithSolutionNaturalIDLink

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

get_solution

Solution get_solution(id)

Solution

Returns the details for a solution that can remediate one or more vulnerabilities.

Example

# load the gem
require 'rapid7_vm_console'

api_instance = Rapid7VmConsole::VulnerabilityApi.new

id = 'id_example' # String | The identifier of the solution.


begin
  #Solution
  result = api_instance.get_solution(id)
  p result
rescue Rapid7VmConsole::ApiError => e
  puts "Exception when calling VulnerabilityApi->get_solution: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String	The identifier of the solution.

Return type

Solution

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

get_solutions

ResourcesSolution get_solutions(opts)

Solutions

Returns the details for all solutions.

Example

# load the gem
require 'rapid7_vm_console'

api_instance = Rapid7VmConsole::VulnerabilityApi.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
  #Solutions
  result = api_instance.get_solutions(opts)
  p result
rescue Rapid7VmConsole::ApiError => e
  puts "Exception when calling VulnerabilityApi->get_solutions: #{e}"
end

Parameters

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.

Return type

ResourcesSolution

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

get_superseded_solutions

ResourcesSolution get_superseded_solutions(id)

Superseded Solutions

Returns the solutions that are superseded by this solution.

Example

# load the gem
require 'rapid7_vm_console'

api_instance = Rapid7VmConsole::VulnerabilityApi.new

id = 'id_example' # String | The identifier of the solution.


begin
  #Superseded Solutions
  result = api_instance.get_superseded_solutions(id)
  p result
rescue Rapid7VmConsole::ApiError => e
  puts "Exception when calling VulnerabilityApi->get_superseded_solutions: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String	The identifier of the solution.

Return type

ResourcesSolution

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

get_superseding_solutions

ResourcesSolution get_superseding_solutions(id, opts)

Superseding Solutions

Returns the solutions that supersede this solution.

Example

# load the gem
require 'rapid7_vm_console'

api_instance = Rapid7VmConsole::VulnerabilityApi.new

id = 'id_example' # String | The identifier of the solution.

opts = { 
  rollup: true # BOOLEAN | Whether to return only highest-level \"rollup\" superseding solutions.
}

begin
  #Superseding Solutions
  result = api_instance.get_superseding_solutions(id, opts)
  p result
rescue Rapid7VmConsole::ApiError => e
  puts "Exception when calling VulnerabilityApi->get_superseding_solutions: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String	The identifier of the solution.
rollup	BOOLEAN	Whether to return only highest-level "rollup" superseding solutions.	[optional] [default to true]

Return type

ResourcesSolution

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

get_vulnerabilities

PageOfVulnerability get_vulnerabilities(opts)

Vulnerabilities

Returns all vulnerabilities that can be assessed during a scan.

Example

# load the gem
require 'rapid7_vm_console'

api_instance = Rapid7VmConsole::VulnerabilityApi.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
  #Vulnerabilities
  result = api_instance.get_vulnerabilities(opts)
  p result
rescue Rapid7VmConsole::ApiError => e
  puts "Exception when calling VulnerabilityApi->get_vulnerabilities: #{e}"
end

Parameters

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.

Return type

PageOfVulnerability

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

get_vulnerability

Vulnerability get_vulnerability(id)

Vulnerability

Returns the details for a vulnerability.

Example

# load the gem
require 'rapid7_vm_console'

api_instance = Rapid7VmConsole::VulnerabilityApi.new

id = 'id_example' # String | The identifier of the vulnerability.


begin
  #Vulnerability
  result = api_instance.get_vulnerability(id)
  p result
rescue Rapid7VmConsole::ApiError => e
  puts "Exception when calling VulnerabilityApi->get_vulnerability: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String	The identifier of the vulnerability.

Return type

Vulnerability

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

get_vulnerability_categories

PageOfVulnerabilityCategory get_vulnerability_categories(opts)

Example

# load the gem
require 'rapid7_vm_console'

api_instance = Rapid7VmConsole::VulnerabilityApi.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
  #Categories
  result = api_instance.get_vulnerability_categories(opts)
  p result
rescue Rapid7VmConsole::ApiError => e
  puts "Exception when calling VulnerabilityApi->get_vulnerability_categories: #{e}"
end

Parameters

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.

Return type

PageOfVulnerabilityCategory

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

get_vulnerability_category

VulnerabilityCategory get_vulnerability_category(id)

Example

# load the gem
require 'rapid7_vm_console'

api_instance = Rapid7VmConsole::VulnerabilityApi.new

id = 56 # Integer | The identifier of the vulnerability category.


begin
  #Category
  result = api_instance.get_vulnerability_category(id)
  p result
rescue Rapid7VmConsole::ApiError => e
  puts "Exception when calling VulnerabilityApi->get_vulnerability_category: #{e}"
end

Parameters

Name	Type	Description	Notes
id	Integer	The identifier of the vulnerability category.

Return type

VulnerabilityCategory

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

get_vulnerability_category_vulnerabilities

ReferencesWithVulnerabilityNaturalIDLink get_vulnerability_category_vulnerabilities(id)

Category Vulnerabilities

Returns hypermedia links to the vulnerabilities that are in a vulnerability category.

Example

# load the gem
require 'rapid7_vm_console'

api_instance = Rapid7VmConsole::VulnerabilityApi.new

id = 56 # Integer | The identifier of the vulnerability category.


begin
  #Category Vulnerabilities
  result = api_instance.get_vulnerability_category_vulnerabilities(id)
  p result
rescue Rapid7VmConsole::ApiError => e
  puts "Exception when calling VulnerabilityApi->get_vulnerability_category_vulnerabilities: #{e}"
end

Parameters

Name	Type	Description	Notes
id	Integer	The identifier of the vulnerability category.

Return type

ReferencesWithVulnerabilityNaturalIDLink

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

get_vulnerability_exploits

PageOfExploit get_vulnerability_exploits(id, opts)

Vulnerability Exploits

Returns the exploits that can be used to exploit a vulnerability.

Example

# load the gem
require 'rapid7_vm_console'

api_instance = Rapid7VmConsole::VulnerabilityApi.new

id = 'id_example' # String | The identifier of the vulnerability.

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
  #Vulnerability Exploits
  result = api_instance.get_vulnerability_exploits(id, opts)
  p result
rescue Rapid7VmConsole::ApiError => e
  puts "Exception when calling VulnerabilityApi->get_vulnerability_exploits: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String	The identifier of the vulnerability.
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.

Return type

PageOfExploit

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

get_vulnerability_malware_kits

PageOfMalwareKit get_vulnerability_malware_kits(id, opts)

Vulnerability Malware Kits

Returns the malware kits that are known to be used to exploit the vulnerability.

Example

# load the gem
require 'rapid7_vm_console'

api_instance = Rapid7VmConsole::VulnerabilityApi.new

id = 'id_example' # String | The identifier of the vulnerability.

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
  #Vulnerability Malware Kits
  result = api_instance.get_vulnerability_malware_kits(id, opts)
  p result
rescue Rapid7VmConsole::ApiError => e
  puts "Exception when calling VulnerabilityApi->get_vulnerability_malware_kits: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String	The identifier of the vulnerability.
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.

Return type

PageOfMalwareKit

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

get_vulnerability_reference

VulnerabilityReference get_vulnerability_reference(id)

Reference

Returns an external vulnerability reference.

Example

# load the gem
require 'rapid7_vm_console'

api_instance = Rapid7VmConsole::VulnerabilityApi.new

id = 56 # Integer | The identifier of the vulnerability reference.


begin
  #Reference
  result = api_instance.get_vulnerability_reference(id)
  p result
rescue Rapid7VmConsole::ApiError => e
  puts "Exception when calling VulnerabilityApi->get_vulnerability_reference: #{e}"
end

Parameters

Name	Type	Description	Notes
id	Integer	The identifier of the vulnerability reference.

Return type

VulnerabilityReference

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

get_vulnerability_reference_vulnerabilities

PageOfVulnerability get_vulnerability_reference_vulnerabilities(id, opts)

Reference Vulnerabilities

Returns the vulnerabilities that are referenced by an external reference.

Example

# load the gem
require 'rapid7_vm_console'

api_instance = Rapid7VmConsole::VulnerabilityApi.new

id = 56 # Integer | id

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
  #Reference Vulnerabilities
  result = api_instance.get_vulnerability_reference_vulnerabilities(id, opts)
  p result
rescue Rapid7VmConsole::ApiError => e
  puts "Exception when calling VulnerabilityApi->get_vulnerability_reference_vulnerabilities: #{e}"
end

Parameters

Name	Type	Description	Notes
id	Integer	id
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.

Return type

PageOfVulnerability

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

get_vulnerability_references

PageOfVulnerabilityReference get_vulnerability_references(opts)

References

Returns the external references that may be associated to a vulnerability.

Example

# load the gem
require 'rapid7_vm_console'

api_instance = Rapid7VmConsole::VulnerabilityApi.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
  #References
  result = api_instance.get_vulnerability_references(opts)
  p result
rescue Rapid7VmConsole::ApiError => e
  puts "Exception when calling VulnerabilityApi->get_vulnerability_references: #{e}"
end

Parameters

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.

Return type

PageOfVulnerabilityReference

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

get_vulnerability_references1

PageOfVulnerabilityReference get_vulnerability_references1(id, opts)

Vulnerability References

Returns the external references that may be associated to a vulnerability.

Example

# load the gem
require 'rapid7_vm_console'

api_instance = Rapid7VmConsole::VulnerabilityApi.new

id = 'id_example' # String | The identifier of the vulnerability.

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
  #Vulnerability References
  result = api_instance.get_vulnerability_references1(id, opts)
  p result
rescue Rapid7VmConsole::ApiError => e
  puts "Exception when calling VulnerabilityApi->get_vulnerability_references1: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String	The identifier of the vulnerability.
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.

Return type

PageOfVulnerabilityReference

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

get_vulnerability_solutions

ReferencesWithSolutionNaturalIDLink get_vulnerability_solutions(id)

Vulnerability Solutions

Returns all solutions (across all platforms) that may be used to remediate this vulnerability.

Example

# load the gem
require 'rapid7_vm_console'

api_instance = Rapid7VmConsole::VulnerabilityApi.new

id = 'id_example' # String | The identifier of the vulnerability.


begin
  #Vulnerability Solutions
  result = api_instance.get_vulnerability_solutions(id)
  p result
rescue Rapid7VmConsole::ApiError => e
  puts "Exception when calling VulnerabilityApi->get_vulnerability_solutions: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String	The identifier of the vulnerability.

Return type

ReferencesWithSolutionNaturalIDLink

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

Files

VulnerabilityApi.md

Latest commit

History

VulnerabilityApi.md

File metadata and controls

Rapid7VmConsole::VulnerabilityApi

get_affected_assets

Example

Parameters

Return type

Authorization

HTTP request headers

get_exploit

Example

Parameters

Return type

Authorization

HTTP request headers

get_exploit_vulnerabilities

Example

Parameters

Return type

Authorization

HTTP request headers

get_exploits

Example

Parameters

Return type

Authorization

HTTP request headers

get_malware_kit

Example

Parameters

Return type

Authorization

HTTP request headers

get_malware_kit_vulnerabilities

Example

Parameters

Return type

Authorization

HTTP request headers

get_malware_kits

Example

Parameters

Return type

Authorization

HTTP request headers

get_prerequisite_solutions

Example

Parameters

Return type

Authorization

HTTP request headers

get_solution

Example

Parameters

Return type

Authorization

HTTP request headers

get_solutions

Example

Parameters

Return type

Authorization

HTTP request headers

get_superseded_solutions

Example

Parameters

Return type

Authorization

HTTP request headers

get_superseding_solutions

Example

Parameters

Return type

Authorization

HTTP request headers

get_vulnerabilities