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 API

Resources and operations for managing scans.

Rapid7 Scan 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. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 4 paths, and defines 15 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.

5 operations 4 paths 15 schemas 3 GET2 POST

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 5

Across 4 paths, the API surfaces 5 operations — 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Scan 5

Resources and operations for managing scans.

GET
/api/3/scans
Scans
getScans 4 params → 200401404500503
GET
/api/3/scans/{id}
Scan
getScan 1 param → 200401404500503
POST
/api/3/scans/{id}/{status}
Scan Status
setScanStatus 2 params → 200400401500503
GET
/api/3/sites/{id}/scans
Site Scans
getSiteScans 5 params → 200401404500503
POST
/api/3/sites/{id}/scans
Site Scans
startScan 3 params → 200400401500503

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are GlobalScan (16 properties), Scan (14 properties), AdhocScan (5 properties), Vulnerabilities (4 properties). Each schema is shown below with its type and property counts.

BadRequestError
object
3 properties 1 required
PageOf«Scan»
object
3 properties
UnauthorizedError
object
3 properties 1 required
Scan
object
14 properties
Vulnerabilities
object
4 properties
Links
object
1 property
ServiceUnavailableError
object
3 properties 1 required
AdhocScan
object
5 properties
PageInfo
object
4 properties
PageOf«GlobalScan»
object
3 properties
NotFoundError
object
3 properties 1 required
GlobalScan
object
16 properties
CreatedReference«ScanID,Link»
object
2 properties
Link
object
2 properties
InternalServerError
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rapid7-scan-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