Skip to content

Latest commit

 

History

History
1234 lines (870 loc) · 42.6 KB

VulnerabilityApi.md

File metadata and controls

1234 lines (870 loc) · 42.6 KB

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

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.VulnerabilityApi()
id = 'id_example' # str | The identifier of the vulnerability.

try:
    # Vulnerability Affected Assets
    api_response = api_instance.get_affected_assets(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VulnerabilityApi->get_affected_assets: %s\n" % e)

Parameters

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_exploit

Exploit get_exploit(id)

Exploit

Returns the details for an exploit.

Example

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.VulnerabilityApi()
id = 56 # int | The identifier of the exploit.

try:
    # Exploit
    api_response = api_instance.get_exploit(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VulnerabilityApi->get_exploit: %s\n" % e)

Parameters

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_exploit_vulnerabilities

ReferencesWithVulnerabilityNaturalIDLink get_exploit_vulnerabilities(id)

Exploitable Vulnerabilities

Returns the vulnerabilities exploitable to a exploit.

Example

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.VulnerabilityApi()
id = 56 # int | The identifier of the exploit.

try:
    # Exploitable Vulnerabilities
    api_response = api_instance.get_exploit_vulnerabilities(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VulnerabilityApi->get_exploit_vulnerabilities: %s\n" % e)

Parameters

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_exploits

PageOfExploit get_exploits(page=page, size=size, sort=sort)

Exploits

Returns all known exploits.

Example

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.VulnerabilityApi()
page = 0 # int | The index of the page (zero-based) to retrieve. (optional) (default to 0)
size = 10 # int | The number of records per page to retrieve. (optional) (default to 10)
sort = ['sort_example'] # list[str] | 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. (optional)

try:
    # Exploits
    api_response = api_instance.get_exploits(page=page, size=size, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VulnerabilityApi->get_exploits: %s\n" % e)

Parameters

Name Type Description Notes
page int The index of the page (zero-based) to retrieve. [optional] [default to 0]
size int The number of records per page to retrieve. [optional] [default to 10]
sort list[str] 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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_malware_kit

MalwareKit get_malware_kit(id)

Malware Kit

Returns the details for a malware kit.

Example

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.VulnerabilityApi()
id = 56 # int | The identifier of the malware kit.

try:
    # Malware Kit
    api_response = api_instance.get_malware_kit(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VulnerabilityApi->get_malware_kit: %s\n" % e)

Parameters

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

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

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.VulnerabilityApi()
id = 56 # int | The identifier of the malware kit.

try:
    # Malware Kit Vulnerabilities
    api_response = api_instance.get_malware_kit_vulnerabilities(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VulnerabilityApi->get_malware_kit_vulnerabilities: %s\n" % e)

Parameters

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_malware_kits

PageOfMalwareKit get_malware_kits(page=page, size=size, sort=sort)

Malware Kits

Returns all known malware kits.

Example

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.VulnerabilityApi()
page = 0 # int | The index of the page (zero-based) to retrieve. (optional) (default to 0)
size = 10 # int | The number of records per page to retrieve. (optional) (default to 10)
sort = ['sort_example'] # list[str] | 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. (optional)

try:
    # Malware Kits
    api_response = api_instance.get_malware_kits(page=page, size=size, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VulnerabilityApi->get_malware_kits: %s\n" % e)

Parameters

Name Type Description Notes
page int The index of the page (zero-based) to retrieve. [optional] [default to 0]
size int The number of records per page to retrieve. [optional] [default to 10]
sort list[str] 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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

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

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.VulnerabilityApi()
id = 'id_example' # str | The identifier of the solution.

try:
    # Solution Prerequisites
    api_response = api_instance.get_prerequisite_solutions(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VulnerabilityApi->get_prerequisite_solutions: %s\n" % e)

Parameters

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_solution

Solution get_solution(id)

Solution

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

Example

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.VulnerabilityApi()
id = 'id_example' # str | The identifier of the solution.

try:
    # Solution
    api_response = api_instance.get_solution(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VulnerabilityApi->get_solution: %s\n" % e)

Parameters

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_solutions

ResourcesSolution get_solutions(page=page, size=size, sort=sort)

Solutions

Returns the details for all solutions.

Example

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.VulnerabilityApi()
page = 0 # int | The index of the page (zero-based) to retrieve. (optional) (default to 0)
size = 10 # int | The number of records per page to retrieve. (optional) (default to 10)
sort = ['sort_example'] # list[str] | 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. (optional)

try:
    # Solutions
    api_response = api_instance.get_solutions(page=page, size=size, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VulnerabilityApi->get_solutions: %s\n" % e)

Parameters

Name Type Description Notes
page int The index of the page (zero-based) to retrieve. [optional] [default to 0]
size int The number of records per page to retrieve. [optional] [default to 10]
sort list[str] 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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_superseded_solutions

ResourcesSolution get_superseded_solutions(id)

Superseded Solutions

Returns the solutions that are superseded by this solution.

Example

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.VulnerabilityApi()
id = 'id_example' # str | The identifier of the solution.

try:
    # Superseded Solutions
    api_response = api_instance.get_superseded_solutions(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VulnerabilityApi->get_superseded_solutions: %s\n" % e)

Parameters

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_superseding_solutions

ResourcesSolution get_superseding_solutions(id, rollup=rollup)

Superseding Solutions

Returns the solutions that supersede this solution.

Example

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.VulnerabilityApi()
id = 'id_example' # str | The identifier of the solution.
rollup = true # bool | Whether to return only highest-level \"rollup\" superseding solutions. (optional) (default to true)

try:
    # Superseding Solutions
    api_response = api_instance.get_superseding_solutions(id, rollup=rollup)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VulnerabilityApi->get_superseding_solutions: %s\n" % e)

Parameters

Name Type Description Notes
id str The identifier of the solution.
rollup bool 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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_vulnerabilities

PageOfVulnerability get_vulnerabilities(page=page, size=size, sort=sort)

Vulnerabilities

Returns all vulnerabilities that can be assessed during a scan.

Example

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.VulnerabilityApi()
page = 0 # int | The index of the page (zero-based) to retrieve. (optional) (default to 0)
size = 10 # int | The number of records per page to retrieve. (optional) (default to 10)
sort = ['sort_example'] # list[str] | 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. (optional)

try:
    # Vulnerabilities
    api_response = api_instance.get_vulnerabilities(page=page, size=size, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VulnerabilityApi->get_vulnerabilities: %s\n" % e)

Parameters

Name Type Description Notes
page int The index of the page (zero-based) to retrieve. [optional] [default to 0]
size int The number of records per page to retrieve. [optional] [default to 10]
sort list[str] 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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_vulnerability

Vulnerability get_vulnerability(id)

Vulnerability

Returns the details for a vulnerability.

Example

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.VulnerabilityApi()
id = 'id_example' # str | The identifier of the vulnerability.

try:
    # Vulnerability
    api_response = api_instance.get_vulnerability(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VulnerabilityApi->get_vulnerability: %s\n" % e)

Parameters

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_vulnerability_categories

PageOfVulnerabilityCategory get_vulnerability_categories(page=page, size=size, sort=sort)

Categories

Returns all vulnerabilities categories that can be assigned to a vulnerability. These categories group and label vulnerabilities by general purpose, affected systems, vendor, etc.

Example

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.VulnerabilityApi()
page = 0 # int | The index of the page (zero-based) to retrieve. (optional) (default to 0)
size = 10 # int | The number of records per page to retrieve. (optional) (default to 10)
sort = ['sort_example'] # list[str] | 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. (optional)

try:
    # Categories
    api_response = api_instance.get_vulnerability_categories(page=page, size=size, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VulnerabilityApi->get_vulnerability_categories: %s\n" % e)

Parameters

Name Type Description Notes
page int The index of the page (zero-based) to retrieve. [optional] [default to 0]
size int The number of records per page to retrieve. [optional] [default to 10]
sort list[str] 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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_vulnerability_category

VulnerabilityCategory get_vulnerability_category(id)

Category

Returns the details for a vulnerability category.

Example

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.VulnerabilityApi()
id = 56 # int | The identifier of the vulnerability category.

try:
    # Category
    api_response = api_instance.get_vulnerability_category(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VulnerabilityApi->get_vulnerability_category: %s\n" % e)

Parameters

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

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

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.VulnerabilityApi()
id = 56 # int | The identifier of the vulnerability category.

try:
    # Category Vulnerabilities
    api_response = api_instance.get_vulnerability_category_vulnerabilities(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VulnerabilityApi->get_vulnerability_category_vulnerabilities: %s\n" % e)

Parameters

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_vulnerability_exploits

PageOfExploit get_vulnerability_exploits(id, page=page, size=size, sort=sort)

Vulnerability Exploits

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

Example

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.VulnerabilityApi()
id = 'id_example' # str | The identifier of the vulnerability.
page = 0 # int | The index of the page (zero-based) to retrieve. (optional) (default to 0)
size = 10 # int | The number of records per page to retrieve. (optional) (default to 10)
sort = ['sort_example'] # list[str] | 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. (optional)

try:
    # Vulnerability Exploits
    api_response = api_instance.get_vulnerability_exploits(id, page=page, size=size, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VulnerabilityApi->get_vulnerability_exploits: %s\n" % e)

Parameters

Name Type Description Notes
id str The identifier of the vulnerability.
page int The index of the page (zero-based) to retrieve. [optional] [default to 0]
size int The number of records per page to retrieve. [optional] [default to 10]
sort list[str] 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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_vulnerability_malware_kits

PageOfMalwareKit get_vulnerability_malware_kits(id, page=page, size=size, sort=sort)

Vulnerability Malware Kits

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

Example

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.VulnerabilityApi()
id = 'id_example' # str | The identifier of the vulnerability.
page = 0 # int | The index of the page (zero-based) to retrieve. (optional) (default to 0)
size = 10 # int | The number of records per page to retrieve. (optional) (default to 10)
sort = ['sort_example'] # list[str] | 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. (optional)

try:
    # Vulnerability Malware Kits
    api_response = api_instance.get_vulnerability_malware_kits(id, page=page, size=size, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VulnerabilityApi->get_vulnerability_malware_kits: %s\n" % e)

Parameters

Name Type Description Notes
id str The identifier of the vulnerability.
page int The index of the page (zero-based) to retrieve. [optional] [default to 0]
size int The number of records per page to retrieve. [optional] [default to 10]
sort list[str] 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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_vulnerability_reference

VulnerabilityReference get_vulnerability_reference(id)

Reference

Returns an external vulnerability reference.

Example

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.VulnerabilityApi()
id = 56 # int | The identifier of the vulnerability reference.

try:
    # Reference
    api_response = api_instance.get_vulnerability_reference(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VulnerabilityApi->get_vulnerability_reference: %s\n" % e)

Parameters

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_vulnerability_reference_vulnerabilities

PageOfVulnerability get_vulnerability_reference_vulnerabilities(id, page=page, size=size, sort=sort)

Reference Vulnerabilities

Returns the vulnerabilities that are referenced by an external reference.

Example

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.VulnerabilityApi()
id = 56 # int | id
page = 0 # int | The index of the page (zero-based) to retrieve. (optional) (default to 0)
size = 10 # int | The number of records per page to retrieve. (optional) (default to 10)
sort = ['sort_example'] # list[str] | 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. (optional)

try:
    # Reference Vulnerabilities
    api_response = api_instance.get_vulnerability_reference_vulnerabilities(id, page=page, size=size, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VulnerabilityApi->get_vulnerability_reference_vulnerabilities: %s\n" % e)

Parameters

Name Type Description Notes
id int id
page int The index of the page (zero-based) to retrieve. [optional] [default to 0]
size int The number of records per page to retrieve. [optional] [default to 10]
sort list[str] 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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_vulnerability_references

PageOfVulnerabilityReference get_vulnerability_references(page=page, size=size, sort=sort)

References

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

Example

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.VulnerabilityApi()
page = 0 # int | The index of the page (zero-based) to retrieve. (optional) (default to 0)
size = 10 # int | The number of records per page to retrieve. (optional) (default to 10)
sort = ['sort_example'] # list[str] | 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. (optional)

try:
    # References
    api_response = api_instance.get_vulnerability_references(page=page, size=size, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VulnerabilityApi->get_vulnerability_references: %s\n" % e)

Parameters

Name Type Description Notes
page int The index of the page (zero-based) to retrieve. [optional] [default to 0]
size int The number of records per page to retrieve. [optional] [default to 10]
sort list[str] 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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_vulnerability_references1

PageOfVulnerabilityReference get_vulnerability_references1(id, page=page, size=size, sort=sort)

Vulnerability References

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

Example

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.VulnerabilityApi()
id = 'id_example' # str | The identifier of the vulnerability.
page = 0 # int | The index of the page (zero-based) to retrieve. (optional) (default to 0)
size = 10 # int | The number of records per page to retrieve. (optional) (default to 10)
sort = ['sort_example'] # list[str] | 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. (optional)

try:
    # Vulnerability References
    api_response = api_instance.get_vulnerability_references1(id, page=page, size=size, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VulnerabilityApi->get_vulnerability_references1: %s\n" % e)

Parameters

Name Type Description Notes
id str The identifier of the vulnerability.
page int The index of the page (zero-based) to retrieve. [optional] [default to 0]
size int The number of records per page to retrieve. [optional] [default to 10]
sort list[str] 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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

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

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.VulnerabilityApi()
id = 'id_example' # str | The identifier of the vulnerability.

try:
    # Vulnerability Solutions
    api_response = api_instance.get_vulnerability_solutions(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VulnerabilityApi->get_vulnerability_solutions: %s\n" % e)

Parameters

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]