Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Rapid7 Scan Engine API

Resources and operations for managing scan engines.

Rapid7 Scan Engine API is one of 50 APIs that Rapid7 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Scan Engine. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 22 operations across 12 paths, and defines 21 schemas. It is described by OpenAPI 3.1.0, at version v1.

Requests are made against a single base URL, https://[region].api.insight.rapid7.com/ias/v1.

22 operations 12 paths 21 schemas 4 DELETE11 GET3 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1
Base URL
https://us.api.insight.rapid7.com/vm/v4
Resource Areas
1

Paths & Operations 22

Across 12 paths, the API surfaces 22 operations — 4 DELETE, 11 GET, 3 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Scan Engine 22

Resources and operations for managing scan engines.

GET
/api/3/scan_engine_pools
Engine Pools
getScanEnginePools → 200401404500503
POST
/api/3/scan_engine_pools
Engine Pools
createScanEnginePool 1 param → 200400401500503
GET
/api/3/scan_engine_pools/{id}
Engine Pool
getEnginePool 1 param → 200401404500503
PUT
/api/3/scan_engine_pools/{id}
Engine Pool
updateScanEnginePool 2 params → 200400401404500503
DELETE
/api/3/scan_engine_pools/{id}
Engine Pool
removeScanEnginePool 1 param → 200401404500503
GET
/api/3/scan_engine_pools/{id}/engines
Engine Pool Engines
getScanEnginePoolScanEngines 1 param → 200401404500503
PUT
/api/3/scan_engine_pools/{id}/engines
Engine Pool Engines
setScanEnginePoolScanEngines 2 params → 200400401404500503
PUT
/api/3/scan_engine_pools/{id}/engines/{engineId}
Engine Pool Engines
addScanEnginePoolScanEngine 2 params → 200400401404500503
DELETE
/api/3/scan_engine_pools/{id}/engines/{engineId}
Engine Pool Engines
removeScanEnginePoolScanEngine 2 params → 200401404500503
GET
/api/3/scan_engine_pools/{id}/sites
Engine Pool Sites
getScanEnginePoolSites 1 param → 200401404500503
GET
/api/3/scan_engines
Scan Engines
getScanEngines → 200401404500503
POST
/api/3/scan_engines
Scan Engines
createScanEngine 1 param → 201400401500503
GET
/api/3/scan_engines/shared_secret
Scan Engine Shared Secret
getCurrentSharedSecret → 200401404500503
POST
/api/3/scan_engines/shared_secret
Scan Engine Shared Secret
createSharedSecret → 201400401500503
DELETE
/api/3/scan_engines/shared_secret
Scan Engine Shared Secret
deleteSharedSecret → 200401404500503
GET
/api/3/scan_engines/shared_secret/time_to_live
Scan Engine Shared Secret Time to live
getCurrentSharedSecretTimeToLive → 200401404500503
GET
/api/3/scan_engines/{id}
Scan Engine
getScanEngine 1 param → 200401404500503
PUT
/api/3/scan_engines/{id}
Scan Engine
updateScanEngine 2 params → 200400401404500503
DELETE
/api/3/scan_engines/{id}
Scan Engine
deleteScanEngine 1 param → 200401404500503
GET
/api/3/scan_engines/{id}/scan_engine_pools
Assigned Engine Pools
getAssignedEnginePools 1 param → 200401404500503
GET
/api/3/scan_engines/{id}/scans
Scan Engine Scans
getScanEngineScans 4 params → 200401404500503
GET
/api/3/scan_engines/{id}/sites
Scan Engine Sites
getScanEngineSites 4 params → 200401404500503

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are Scan (14 properties), Site (13 properties), ScanEngine (12 properties), PageInfo (4 properties). Each schema is shown below with its type and property counts.

ScanEngine
object
12 properties 4 required
PageOf«Scan»
object
3 properties
Scan
object
14 properties
NotFoundError
object
3 properties 1 required
InternalServerError
object
3 properties 1 required
EnginePool
object
4 properties 2 required
Site
object
13 properties
Links
object
1 property
UnauthorizedError
object
3 properties 1 required
CreatedReference«EngineID,Link»
object
2 properties
Vulnerabilities
object
4 properties
ServiceUnavailableError
object
3 properties 1 required
Resources«ScanEngine»
object
2 properties
ReferenceWith«EngineID,Link»
object
2 properties
Resources«EnginePool»
object
2 properties
BadRequestError
object
3 properties 1 required
ReferencesWith«SiteID,Link»
object
2 properties
PageOf«Site»
object
3 properties
ReferencesWith«EngineID,Link»
object
2 properties
PageInfo
object
4 properties
Link
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rapid7-scan-engine-api-openapi.yml Raw ↑

Other APIs Rapid7 publishes across the network.

Rapid7 InsightVM Cloud API
Rapid7 Insight Platform API
Rapid7 InsightIDR API
Rapid7 Accounts API
Rapid7 Administration API
Rapid7 Apps API
Rapid7 Asset API
Rapid7 Asset Discovery API
Rapid7 Asset Group API
Rapid7 Assets API
Rapid7 Attachments API
Rapid7 Attack Templates API