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

An API used to manage collectors for an organization.

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

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

This API exposes 1 operation across 1 path, and defines 4 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.

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

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

Collectors 1

An API used to manage collectors for an organization.

POST
/idr/v1/collectors
Add Collector
addCollector body → 200400401403404405500502

Schemas 4

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

AddCollectorResponse
object
Response from creating a collector
3 properties 3 required
AddCollectorRequest
object
Request body for creating a collector
3 properties 2 required
RRN1
object
The unique identifier for this collector.
6 properties
ErrorResponse
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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