Rapid7 Apps API
An App owns Scan Configs, Schedules, Scans and Vulnerabilities; you must create an App in order to create any of these other resources. Consequently, if an App is deleted it will delete all of these owned resources. App URLs cannot currently be configured via the API, and as such, it is recommended not to use this feature for Apps which are to be primarily managed via the API.
Rapid7 Apps API is one of 50 APIs that Rapid7 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Apps. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 11 operations across 6 paths, and defines 13 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 11
Across 6 paths, the API surfaces 11 operations — 3 DELETE, 4 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
An App owns Scan Configs, Schedules, Scans and Vulnerabilities; you must create an App in order to create any of these other resources. Consequently, if an App is deleted it will…
Schemas 13
The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are PageMetadata (6 properties), ValidationErrors (4 properties), Link (4 properties), EntityModelApp (4 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.