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

An API used to find and search InsightIDR assets. See https://docs.rapid7.com/insightidr/assets-on-your-domain for further information on assets.

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

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

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

2 operations 2 paths 7 schemas 1 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 2

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

Assets 2

An API used to find and search InsightIDR assets. See https://docs.rapid7.com/insightidr/assets-on-your-domain for further information on assets.

POST
/idr/v1/assets/_search
Search assets
searchAssets 2 params body → 200400401403404405500502
GET
/idr/v1/assets/{rrn}
Get asset by RRN
findAssetByRrn 1 param → 200400401403404405500502

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are PageMetadata (4 properties), SearchRequestCriteria (3 properties), ErrorResponse (2 properties), AssetV2 (2 properties). Each schema is shown below with its type and property counts.

PageMetadata
object
The pagination parameters used to generate this page result. Depending on the API, additional parameters may be dynamically present.
4 properties 4 required
SearchRequest
object
2 properties
PageAssetV2
object
2 properties 2 required
SearchRequestSort
object
The sorting information.
2 properties
AssetV2
object
The asset this local account is associated with.
2 properties 2 required
ErrorResponse
object
2 properties 1 required
SearchRequestCriteria
object
The criteria for which entities to return.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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