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 Community Threats API

An API used to add and replace indicators for Community Threats. See https://insightidr.help.rapid7.com/docs/threats#section-threat-api for further information on how to generate threat keys.

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

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

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

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

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

Community Threats 4

An API used to add and replace indicators for Community Threats. See https://insightidr.help.rapid7.com/docs/threatssection-threat-api for further information on how to generate t…

POST
/idr/v1/customthreats
Create a Community Threat
createCommunityThreat body → 200400401403404405413500
POST
/idr/v1/customthreats/key/{key}/indicators/replace
Replace indicators for a Community Threat
replaceIndicators 2 params body → 200400401403404405413500
POST
/idr/v1/customthreats/key/{key}/indicators/add
Add indicators to a Community Threat
addIndicators 2 params body → 200400401403404405413500
POST
/idr/v1/customthreats/key/{key}/delete
Delete a Community Threat
deleteCommunityThreat 1 param body → 200400401403404405500502

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Threat (4 properties), ErrorResponse (2 properties), ThreatUpdateResult (2 properties), DeleteThreatEvent (1 property). Each schema is shown below with its type and property counts.

DeleteThreatEvent
object
1 property
ThreatUpdateResult
object
2 properties 1 required
Threat
object
The information about the threat.
4 properties 3 required
ErrorResponse
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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