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

A Vulnerability is a resource that encapsulates any information found by any Scan over the lifetime of an App, that may identify where and how an App could be exploited. Each Vulnerability contains information about the Root Cause (location) and Variances (attack types and natures) which contribute to the evidence that the Vulnerability exists. A Vulnerability cannot be explicitly created or deleted via the API, as its life cycle is managed by the product; but, it can be implicitly created by submitting a Scan and can be implicitly deleted by deleting the App that owns it. There are a number of fields which are mutable and can help to control the workflow of the management of an App's Vulnerabilities.

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

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

This API exposes 9 operations across 8 paths, and defines 18 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.

9 operations 8 paths 18 schemas 8 GET1 PUT

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 9

Across 8 paths, the API surfaces 9 operations — 8 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Vulnerabilities 9

A Vulnerability is a resource that encapsulates any information found by any Scan over the lifetime of an App, that may identify where and how an App could be exploited. Each Vuln…

GET
/modules
Get Modules
get-modules → 415200400401403404500
GET
/modules/{module-id}
Get Module
get-module 1 param → 415200400401403404500
GET
/modules/{module-id}/attacks/{attack-id}
Get Attack
get-attack 2 params → 415200400401403404500
GET
/modules/{module-id}/attacks/{attack-id}/documentation
Get Attack Documentation
get-attack-documentation 2 params → 415200400401403404500
GET
/vulnerabilities
Get Vulnerabilities
get-vulnerabilities 4 params → 415200400401403404500
GET
/vulnerabilities/{vuln-id}
Get Vulnerability
get-vulnerability 1 param → 415200400401403404500
PUT
/vulnerabilities/{vuln-id}
Update Vulnerability
update-vulnerability 1 param body → 415200400401403404500409
GET
/vulnerabilities/{vuln-id}/discoveries
Get Vulnerability Discoveries
get-vulnerability-discoveries 5 params → 415200400401403404500
GET
/vulnerabilities/{vuln-id}/discoveries/{vuln-discovery-id}
Get Vulnerability Discovery
get-vulnerability-discovery 2 params → 415200400401403404500

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are EntityModelVulnerability (14 properties), Vulnerability (13 properties), Variance (11 properties), PageMetadata (6 properties). Each schema is shown below with its type and property counts.

ReadOnlyIdResource
object
The ID of the module
1 property
Vulnerability
object
13 properties
StringReferenceResource
object
The ID of the attack
1 property
ValidationErrors
object
4 properties
PageVulnerability
object
3 properties
RootCause
object
A descriptor for the location of the Vulnerability
3 properties
Link
object
4 properties
PageMetadata
object
6 properties
Variance
object
Evidence found that indicates the presence of a Vulnerability
11 properties
Exchange
object
The HTTP exchange executed as part of the attack
3 properties
EntityModelVulnerabilityDiscovery
object
5 properties
AttackMetadata
object
4 properties
AttackDocumentation
object
3 properties
ModuleMetadata
object
3 properties
ValidationError
object
3 properties
PageVulnerabilityDiscovery
object
3 properties
Error
object
3 properties
EntityModelVulnerability
object
14 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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