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

The Investigations API from Rapid7 — 4 operation(s) for investigations.

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

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

This API exposes 4 operations across 4 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.

4 operations 4 paths 9 schemas 1 GET1 POST2 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 4

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

Investigations 4
PUT
/idr/v1/investigations/{id}/status/{status}
Set the status of an investigation
setStatus 2 params → 200400401403404405500502
PUT
/idr/v1/investigations/{id}/assignee
Assign user to investigation
assignUserToInvestigation 1 param body → 200400401403404405500502
POST
/idr/v1/investigations/bulk_close
Close investigations in bulk
bulkCloseInvestigations body → 200400401403404405500502
GET
/idr/v1/investigations
List investigations
listInvestigations 5 params → 200400401403404405500502

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Investigation (9 properties), BulkCloseInvestigationsRequest (6 properties), PageMetadata3 (4 properties), AlertInfo (3 properties). Each schema is shown below with its type and property counts.

PageMetadata3
object
4 properties 4 required
ClosedInvestigations
object
2 properties 2 required
AlertInfo
object
3 properties 1 required
Assignee
object
2 properties 2 required
Investigation
object
9 properties 6 required
BulkCloseInvestigationsRequest
object
The criteria for what investigations to close.
6 properties 3 required
AssignUserToInvestigationRequest
object
Details about which user to assign.
1 property 1 required
ErrorResponse3
object
2 properties 1 required
PageInvestigation
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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