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 Reports API

Reports provide the ability to share information with stakeholders at both scan and app levels. The following table lists the report templates and the various formats that are available: Report Type Report Format VULN_SUMMARY PDF HTML CSV VULN_REMEDIATION PDF HTML PCI_COMPLIANCE PDF HTML PCI4_COMPLIANCE PDF HTML OWASP_2013_COMPLIANCE PDF HTML OWASP_2017_COMPLIANCE PDF HTML OWASP_2021_COMPLIANCE PDF HTML OWASP_2023API_COMPLIANCE PDF HTML OWASP_2025_COMPLIANCE PDF HTML GDPR_2016_COMPLIANCE PDF HTML SOX_COMPLIANCE PDF HTML HIPAA_COMPLIANCE PDF HTML EXEC_SINGLE_APP (deprecated) PDF HTML EXEC_ALL_APPS (deprecated) PDF EXEC_SINGLE_APP_NEW_VULNS PDF HTML EXEC_ALL_APP_NEW_VULNS PDF EXEC_SINGLE_APP_ALL_VULNS PDF HTML EXEC_ALL_APP_ALL_VULNS PDF EXEC_IAS_IVM_COMPOSITE PDF

Rapid7 Reports API is one of 50 APIs that Rapid7 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Reports. The published artifact set on APIs.io includes an OpenAPI specification.

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

4 operations 2 paths 12 schemas 1 DELETE2 GET1 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 4

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

Reports 4

Reports provide the ability to share information with stakeholders at both scan and app levels. The following table lists the report templates and the various formats that are ava…

GET
/reports
Get Reports
get-reports 4 params → 415200400401403404500
POST
/reports
Generate Report
generate-report body → 415201400401403404500409
GET
/reports/{report-id}
Get Report
get-report 1 param → 415200400401403404500
DELETE
/reports/{report-id}
Delete Report
delete-report 1 param → 415204400401403404500409

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are EntityModelReport (9 properties), ReportGeneration (9 properties), PageMetadata (6 properties), Link (4 properties). Each schema is shown below with its type and property counts.

ReadOnlyIdResource
object
The ID of the module
1 property
ValidationErrors
object
4 properties
PageReport
object
3 properties
Link
object
4 properties
PageMetadata
object
6 properties
app
object
The App that the Scan is associated with
1 property
ReferenceResource
object
The last editor of the comment
1 property 1 required
ValidationError
object
3 properties
ReportGeneration
object
9 properties 3 required
scan
object
The Scan associated with the Report
1 property
Error
object
3 properties
EntityModelReport
object
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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