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

An API used to upload, list, download and delete attachments. For example, the create API can be used to upload an attachment.

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

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

This API exposes 5 operations across 3 paths, and defines 7 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 7 schemas 1 DELETE3 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 5

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

Attachments 5

An API used to upload, list, download and delete attachments. For example, the create API can be used to upload an attachment.

GET
/idr/v1/attachments
List attachments
listAttachments 3 params → 200400401403404405500502
POST
/idr/v1/attachments
Upload attachment
uploadAttachment body → 200400401403404405500502
GET
/idr/v1/attachments/{rrn}
Download attachment
downloadAttachment 1 param → 200400401403404405500502
DELETE
/idr/v1/attachments/{rrn}
Delete an attachment
deleteAttachment 1 param → 204400401403404405500502
GET
/idr/v1/attachments/{rrn}/metadata
Get attachment information
getAttachment 1 param → 200400401403404405500502

Schemas 7

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

PageAttachment
object
2 properties 2 required
RRN
object
6 properties
Attachment
object
7 properties 7 required
PageMetadata1
object
4 properties 4 required
ErrorResponse1
object
2 properties 1 required
UploadAttachmentRequest
object
1 property
Creator
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rapid7-attachments-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 Attack Templates API
Rapid7 Blackouts API