All URIs are relative to https://localhost:3780
Method | HTTP request | Description |
---|---|---|
add_scan_engine_pool_scan_engine | PUT /api/3/scan_engine_pools/{id}/engines/{engineId} | Engine Pool Engines |
create_scan_engine | POST /api/3/scan_engines | Scan Engines |
create_scan_engine_pool | POST /api/3/scan_engine_pools | Engine Pools |
create_shared_secret | POST /api/3/scan_engines/shared_secret | Scan Engine Shared Secret |
delete_scan_engine | DELETE /api/3/scan_engines/{id} | Scan Engine |
delete_shared_secret | DELETE /api/3/scan_engines/shared_secret | Scan Engine Shared Secret |
get_assigned_engine_pools | GET /api/3/scan_engines/{id}/scan_engine_pools | Assigned Engine Pools |
get_current_shared_secret | GET /api/3/scan_engines/shared_secret | Scan Engine Shared Secret |
get_current_shared_secret_time_to_live | GET /api/3/scan_engines/shared_secret/time_to_live | Scan Engine Shared Secret Time to live |
get_engine_pool | GET /api/3/scan_engine_pools/{id} | Engine Pool |
get_scan_engine | GET /api/3/scan_engines/{id} | Scan Engine |
get_scan_engine_pool_scan_engines | GET /api/3/scan_engine_pools/{id}/engines | Engine Pool Engines |
get_scan_engine_pool_sites | GET /api/3/scan_engine_pools/{id}/sites | Engine Pool Sites |
get_scan_engine_pools | GET /api/3/scan_engine_pools | Engine Pools |
get_scan_engine_scans | GET /api/3/scan_engines/{id}/scans | Scan Engine Scans |
get_scan_engine_sites | GET /api/3/scan_engines/{id}/sites | Scan Engine Sites |
get_scan_engines | GET /api/3/scan_engines | Scan Engines |
remove_scan_engine_pool | DELETE /api/3/scan_engine_pools/{id} | Engine Pool |
remove_scan_engine_pool_scan_engine | DELETE /api/3/scan_engine_pools/{id}/engines/{engineId} | Engine Pool Engines |
set_scan_engine_pool_scan_engines | PUT /api/3/scan_engine_pools/{id}/engines | Engine Pool Engines |
update_scan_engine | PUT /api/3/scan_engines/{id} | Scan Engine |
update_scan_engine_pool | PUT /api/3/scan_engine_pools/{id} | Engine Pool |
Links add_scan_engine_pool_scan_engine(id, engine_id)
Engine Pool Engines
Add an engine to the engine pool.
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.ScanEngineApi()
id = 56 # int | The identifier of the engine pool.
engine_id = 56 # int | The identifier of the scan engine.
try:
# Engine Pool Engines
api_response = api_instance.add_scan_engine_pool_scan_engine(id, engine_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ScanEngineApi->add_scan_engine_pool_scan_engine: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | int | The identifier of the engine pool. | |
engine_id | int | The identifier of the scan engine. |
No authorization required
- Content-Type: application/json
- Accept: application/json;charset=UTF-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ReferenceWithEngineIDLink create_scan_engine(scan_engine=scan_engine)
Scan Engines
Creates a new scan engine.
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.ScanEngineApi()
scan_engine = rapid7vmconsole.ScanEngine() # ScanEngine | The specification of a scan engine. (optional)
try:
# Scan Engines
api_response = api_instance.create_scan_engine(scan_engine=scan_engine)
pprint(api_response)
except ApiException as e:
print("Exception when calling ScanEngineApi->create_scan_engine: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
scan_engine | ScanEngine | The specification of a scan engine. | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json;charset=UTF-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CreatedReferenceEngineIDLink create_scan_engine_pool(engine_pool=engine_pool)
Engine Pools
Creates a new engine pool.
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.ScanEngineApi()
engine_pool = rapid7vmconsole.EnginePool() # EnginePool | The details for the scan engine to update. (optional)
try:
# Engine Pools
api_response = api_instance.create_scan_engine_pool(engine_pool=engine_pool)
pprint(api_response)
except ApiException as e:
print("Exception when calling ScanEngineApi->create_scan_engine_pool: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
engine_pool | EnginePool | The details for the scan engine to update. | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json;charset=UTF-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str create_shared_secret()
Scan Engine Shared Secret
Returns the current valid shared secret or generates a new shared secret. The endpoint returns an existing shared secret if one was previously generated and it has not yet expired. Conversely, the endpoint will generate and return a new shared secret for either of the following conditions: a shared secret was not previously generated or the previously-generated shared secret has expired. The shared secret is valid for 60 minutes from the moment it is generated.
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.ScanEngineApi()
try:
# Scan Engine Shared Secret
api_response = api_instance.create_shared_secret()
pprint(api_response)
except ApiException as e:
print("Exception when calling ScanEngineApi->create_shared_secret: %s\n" % e)
This endpoint does not need any parameter.
str
No authorization required
- Content-Type: application/json
- Accept: text/plain
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Links delete_scan_engine(id)
Scan Engine
Deletes the specified scan engine.
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.ScanEngineApi()
id = 56 # int | The identifier of the scan engine.
try:
# Scan Engine
api_response = api_instance.delete_scan_engine(id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ScanEngineApi->delete_scan_engine: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | int | The identifier of the scan engine. |
No authorization required
- Content-Type: application/json
- Accept: application/json;charset=UTF-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Links delete_shared_secret()
Scan Engine Shared Secret
Revokes the current valid shared secret, if one exists.
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.ScanEngineApi()
try:
# Scan Engine Shared Secret
api_response = api_instance.delete_shared_secret()
pprint(api_response)
except ApiException as e:
print("Exception when calling ScanEngineApi->delete_shared_secret: %s\n" % e)
This endpoint does not need any parameter.
No authorization required
- Content-Type: application/json
- Accept: application/json;charset=UTF-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResourcesEnginePool get_assigned_engine_pools(id)
Assigned Engine Pools
Retrieves the list of engine pools the scan engine is currently assigned to.
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.ScanEngineApi()
id = 56 # int | The identifier of the scan engine.
try:
# Assigned Engine Pools
api_response = api_instance.get_assigned_engine_pools(id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ScanEngineApi->get_assigned_engine_pools: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | int | The identifier of the scan engine. |
No authorization required
- Content-Type: application/json
- Accept: application/json;charset=UTF-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str get_current_shared_secret()
Scan Engine Shared Secret
Returns the current valid shared secret, if one has been previously generated and it has not yet expired; otherwise the endpoint will respond with a 404 status code. Use this endpoint to detect whether a previously-generated shared secret is still valid.
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.ScanEngineApi()
try:
# Scan Engine Shared Secret
api_response = api_instance.get_current_shared_secret()
pprint(api_response)
except ApiException as e:
print("Exception when calling ScanEngineApi->get_current_shared_secret: %s\n" % e)
This endpoint does not need any parameter.
str
No authorization required
- Content-Type: application/json
- Accept: text/plain
[Back to top] [Back to API list] [Back to Model list] [Back to README]
int get_current_shared_secret_time_to_live()
Scan Engine Shared Secret Time to live
Returns the number of seconds remaining for the current shared secret before it expires, if one has been previously generated and it has not yet expired; otherwise the endpoint will respond with a 404 status code.
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.ScanEngineApi()
try:
# Scan Engine Shared Secret Time to live
api_response = api_instance.get_current_shared_secret_time_to_live()
pprint(api_response)
except ApiException as e:
print("Exception when calling ScanEngineApi->get_current_shared_secret_time_to_live: %s\n" % e)
This endpoint does not need any parameter.
int
No authorization required
- Content-Type: application/json
- Accept: application/json;charset=UTF-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
EnginePool get_engine_pool(id)
Engine Pool
Retrieves the details for an engine pool.
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.ScanEngineApi()
id = 56 # int | The identifier of the engine pool.
try:
# Engine Pool
api_response = api_instance.get_engine_pool(id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ScanEngineApi->get_engine_pool: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | int | The identifier of the engine pool. |
No authorization required
- Content-Type: application/json
- Accept: application/json;charset=UTF-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ScanEngine get_scan_engine(id)
Scan Engine
Retrieves the details for a scan engine.
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.ScanEngineApi()
id = 56 # int | The identifier of the scan engine.
try:
# Scan Engine
api_response = api_instance.get_scan_engine(id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ScanEngineApi->get_scan_engine: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | int | The identifier of the scan engine. |
No authorization required
- Content-Type: application/json
- Accept: application/json;charset=UTF-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ReferencesWithEngineIDLink get_scan_engine_pool_scan_engines(id)
Engine Pool Engines
Get the engines in the engine pool.
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.ScanEngineApi()
id = 56 # int | The identifier of the engine pool.
try:
# Engine Pool Engines
api_response = api_instance.get_scan_engine_pool_scan_engines(id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ScanEngineApi->get_scan_engine_pool_scan_engines: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | int | The identifier of the engine pool. |
No authorization required
- Content-Type: application/json
- Accept: application/json;charset=UTF-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ReferencesWithSiteIDLink get_scan_engine_pool_sites(id)
Engine Pool Sites
Returns links to the sites associated with this engine pool.
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.ScanEngineApi()
id = 56 # int | The identifier of the engine pool.
try:
# Engine Pool Sites
api_response = api_instance.get_scan_engine_pool_sites(id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ScanEngineApi->get_scan_engine_pool_sites: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | int | The identifier of the engine pool. |
No authorization required
- Content-Type: application/json
- Accept: application/json;charset=UTF-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResourcesEnginePool get_scan_engine_pools()
Engine Pools
Returns engine pools available to use for scanning.
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.ScanEngineApi()
try:
# Engine Pools
api_response = api_instance.get_scan_engine_pools()
pprint(api_response)
except ApiException as e:
print("Exception when calling ScanEngineApi->get_scan_engine_pools: %s\n" % e)
This endpoint does not need any parameter.
No authorization required
- Content-Type: application/json
- Accept: application/json;charset=UTF-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PageOfScan get_scan_engine_scans(id, page=page, size=size, sort=sort)
Scan Engine Scans
Returns the scans that have been run on a scan engine.
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.ScanEngineApi()
id = 56 # int | The identifier of the scan engine.
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:
# Scan Engine Scans
api_response = api_instance.get_scan_engine_scans(id, page=page, size=size, sort=sort)
pprint(api_response)
except ApiException as e:
print("Exception when calling ScanEngineApi->get_scan_engine_scans: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | int | The identifier of the scan engine. | |
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. |
No authorization required
- Content-Type: application/json
- Accept: application/json;charset=UTF-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PageOfSite get_scan_engine_sites(id, page=page, size=size, sort=sort)
Scan Engine Sites
Retrieves the list of sites the specified scan engine is assigned to.
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.ScanEngineApi()
id = 56 # int | The identifier of the scan engine.
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:
# Scan Engine Sites
api_response = api_instance.get_scan_engine_sites(id, page=page, size=size, sort=sort)
pprint(api_response)
except ApiException as e:
print("Exception when calling ScanEngineApi->get_scan_engine_sites: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | int | The identifier of the scan engine. | |
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. |
No authorization required
- Content-Type: application/json
- Accept: application/json;charset=UTF-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResourcesScanEngine get_scan_engines()
Scan Engines
Returns scan engines available to use for scanning.
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.ScanEngineApi()
try:
# Scan Engines
api_response = api_instance.get_scan_engines()
pprint(api_response)
except ApiException as e:
print("Exception when calling ScanEngineApi->get_scan_engines: %s\n" % e)
This endpoint does not need any parameter.
No authorization required
- Content-Type: application/json
- Accept: application/json;charset=UTF-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Links remove_scan_engine_pool(id)
Engine Pool
Deletes the specified engine pool.
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.ScanEngineApi()
id = 56 # int | The identifier of the engine pool.
try:
# Engine Pool
api_response = api_instance.remove_scan_engine_pool(id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ScanEngineApi->remove_scan_engine_pool: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | int | The identifier of the engine pool. |
No authorization required
- Content-Type: application/json
- Accept: application/json;charset=UTF-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Links remove_scan_engine_pool_scan_engine(id, engine_id)
Engine Pool Engines
Remove the specified engine from the engine pool.
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.ScanEngineApi()
id = 56 # int | The identifier of the engine pool.
engine_id = 56 # int | The identifier of the scan engine.
try:
# Engine Pool Engines
api_response = api_instance.remove_scan_engine_pool_scan_engine(id, engine_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ScanEngineApi->remove_scan_engine_pool_scan_engine: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | int | The identifier of the engine pool. | |
engine_id | int | The identifier of the scan engine. |
No authorization required
- Content-Type: application/json
- Accept: application/json;charset=UTF-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Links set_scan_engine_pool_scan_engines(id, engines=engines)
Engine Pool Engines
Set the engines in the engine pool.
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.ScanEngineApi()
id = 56 # int | The identifier of the engine pool.
engines = [rapid7vmconsole.list[int]()] # list[int] | The identifiers of the scan engines to place into the engine pool. (optional)
try:
# Engine Pool Engines
api_response = api_instance.set_scan_engine_pool_scan_engines(id, engines=engines)
pprint(api_response)
except ApiException as e:
print("Exception when calling ScanEngineApi->set_scan_engine_pool_scan_engines: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | int | The identifier of the engine pool. | |
engines | list[int] | The identifiers of the scan engines to place into the engine pool. | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json;charset=UTF-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Links update_scan_engine(id, scan_engine=scan_engine)
Scan Engine
Updates the specified scan engine.
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.ScanEngineApi()
id = 56 # int | The identifier of the scan engine.
scan_engine = rapid7vmconsole.ScanEngine() # ScanEngine | The specification of the scan engine to update. (optional)
try:
# Scan Engine
api_response = api_instance.update_scan_engine(id, scan_engine=scan_engine)
pprint(api_response)
except ApiException as e:
print("Exception when calling ScanEngineApi->update_scan_engine: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | int | The identifier of the scan engine. | |
scan_engine | ScanEngine | The specification of the scan engine to update. | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json;charset=UTF-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Links update_scan_engine_pool(id, engine_pool=engine_pool)
Engine Pool
Updates the specified engine pool.
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.ScanEngineApi()
id = 56 # int | The identifier of the engine pool.
engine_pool = rapid7vmconsole.EnginePool() # EnginePool | The details for the scan engine to update. (optional)
try:
# Engine Pool
api_response = api_instance.update_scan_engine_pool(id, engine_pool=engine_pool)
pprint(api_response)
except ApiException as e:
print("Exception when calling ScanEngineApi->update_scan_engine_pool: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | int | The identifier of the engine pool. | |
engine_pool | EnginePool | The details for the scan engine to update. | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json;charset=UTF-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]