Rapid7 Scan Configs API
A Scan Config defines all the necessary information required to perform a Scan of an App. An App must be created prior to creating a Scan Config. It is the main document that describes what and how web resources should be discovered and Scanned, and can be tailored from Scan to Scan in order to refine the results gathered. It must define which Attack Template to use during the attacking phase of the Scan. Currently, all Scan Configs created via the API will by default specify that Scans will be executed on Cloud engines; support for On-Premise engines is available by specifying appropriate assignment ID (a known engine group ID), type (ENGINE_GROUP) and environment (ON_PREMISE) values. A Scan Config must define a minimum set of Options that specify the following:At least one Seed URLAt least one Crawling Scope ConstraintIf any of the Options defined for a Scan Config are considered invalid, an explanatory message should be included in the "errors" property of the owning Scan Config response body. All Seed URLs and Scope Constraint URLs provided must have a valid Target.
Rapid7 Scan Configs 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 Configs. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 9 operations across 4 paths, and defines 89 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.
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 9
Across 4 paths, the API surfaces 9 operations — 1 DELETE, 4 GET, 1 PATCH, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
A Scan Config defines all the necessary information required to perform a Scan of an App. An App must be created prior to creating a Scan Config. It is the main document that desc…
Schemas 89
The contract defines 89 schemas that model the data the API accepts and returns. The most detailed are CrawlConfig (103 properties), AuthConfig (68 properties), ScanConfigOptions (24 properties), NetworkSettingsConfig (20 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Rapid7 12
Other APIs Rapid7 publishes across the network.