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 Vulnerability Comments API

A Vulnerability Comment is a resource that allows users to add context to the Vulnerability.

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

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

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

5 operations 2 paths 9 schemas 1 DELETE2 GET1 POST1 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 5

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

Vulnerability Comments 5

A Vulnerability Comment is a resource that allows users to add context to the Vulnerability.

GET
/vulnerabilities/{vuln-id}/comments
Get Vulnerability Comments
get-vulnerability-comments 1 param → 415200400401403404500
POST
/vulnerabilities/{vuln-id}/comments
Create Vulnerability Comment
create-vulnerability-comment 1 param body → 415201400401403404500409
GET
/vulnerabilities/{vuln-id}/comments/{comment-id}
Get Vulnerability Comment
get-vulnerability-comment 2 params → 415200400401403404500
PUT
/vulnerabilities/{vuln-id}/comments/{comment-id}
Update Vulnerability Comment
update-vulnerability-comment 2 params body → 415200400401403404500409
DELETE
/vulnerabilities/{vuln-id}/comments/{comment-id}
Delete Vulnerability Comment
delete-vulnerability-comment 2 params → 415204400401403404500409

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are EntityModelVulnerabilityComment (8 properties), VulnerabilityComment (7 properties), PageMetadata (6 properties), ValidationErrors (4 properties). Each schema is shown below with its type and property counts.

ValidationErrors
object
4 properties
Link
object
4 properties
PageMetadata
object
6 properties
PageVulnerabilityComment
object
3 properties
EntityModelVulnerabilityComment
object
8 properties 1 required
ReferenceResource
object
The last editor of the comment
1 property 1 required
ValidationError
object
3 properties
Error
object
3 properties
VulnerabilityComment
object
7 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rapid7-vulnerability-comments-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