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

An API used to find, create, and delete comments. For example, these APIs can be used to create a comment for a particular investigation.

Rapid7 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 Comments. The published artifact set on APIs.io includes an OpenAPI specification.

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

Comments 5

An API used to find, create, and delete comments. For example, these APIs can be used to create a comment for a particular investigation.

PUT
/idr/v1/comments/{rrn}/{visibility}
Update comment visibility
updateComment 2 params → 400401403404405500502503
GET
/idr/v1/comments
List comments
listComments 3 params → 200400401403404405500502
POST
/idr/v1/comments
Create comment
createComment body → 200400401403404405500502
GET
/idr/v1/comments/{rrn}
Get comment by rrn
getComment 1 param → 200400401403404405500502
DELETE
/idr/v1/comments/{rrn}
Delete a comment
deleteComment 1 param → 204400401403404405500502

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Attachment (7 properties), Comment (7 properties), RRN (6 properties), PageMetadata2 (4 properties). Each schema is shown below with its type and property counts.

PageMetadata2
object
4 properties 4 required
RRN
object
6 properties
Attachment
object
7 properties 7 required
PageComment
object
2 properties 2 required
Comment
object
7 properties 4 required
ErrorResponse2
object
2 properties 1 required
CommentCreateRequest
object
The information needed by the request body to create comments.
3 properties 1 required
Creator
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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