Rapid7 Report API
Resources and operations for managing and generating reports. Reports are broadly categorized into `document`, `export`, and `file` types. `document` reports use section-based report templates to control the output and can be generated in several formats. `export` reports are designed to output their contents into a specific file format. `file` reports are templatized reports that output based on the format of a template file. Reports can be configured to generate on a schedule and be distributed via email to specific recipients.
Rapid7 Report API is one of 50 APIs that Rapid7 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Report. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 13 operations across 9 paths, and defines 33 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 13
Across 9 paths, the API surfaces 13 operations — 2 DELETE, 8 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Resources and operations for managing and generating reports. Reports are broadly categorized into document, export, and file types. document reports use section-based report temp…
Schemas 33
The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are Report (27 properties), RiskTrendResource (9 properties), ReportTemplate (7 properties), ReportInstance (6 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.