How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
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.2.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.2.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), EnginePool (4 properties). Each schema is shown below with its type and property counts.

PageInfo
object
4 properties
BadRequestError
object
3 properties 1 required
InternalServerError
object
3 properties 1 required
Site
object
13 properties
UnauthorizedError
object
3 properties 1 required
EnginePool
object
4 properties 2 required
PageOf«Site»
object
3 properties
ScanEngine
object
12 properties 4 required
Resources«ScanEngine»
object
2 properties
Scan
object
14 properties
CreatedReference«EngineID,Link»
object
2 properties
NotFoundError
object
3 properties 1 required
Links
object
1 property
PageOf«Scan»
object
3 properties
Link
object
2 properties
ServiceUnavailableError
object
3 properties 1 required
ReferencesWith«EngineID,Link»
object
2 properties
Resources«EnginePool»
object
2 properties
Vulnerabilities
object
4 properties
ReferenceWith«EngineID,Link»
object
2 properties
ReferencesWith«SiteID,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
Where this information came from

This is an independent, third-party profile of Rapid7 Scan Engine API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.