Rapid7 Health Metrics API
An API used to retrieve health metrics of an organization.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/rapid7-health-metrics-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: InsightIDR Health Metrics API
version: v1
description: 'Introduction
Welcome to the reference documentation for the InsightIDR public APIs.
Here are a few resources to help you learn how to start using our APIs:
Learn about basic concepts and capabilities
Get an Insight platform API key to set up authentication
See available Insight product APIs
Learn more about InsightIDR
After you''ve got the basics down, you can use this API guide to find examples of requests and responses.'
servers:
- url: https://{region}.api.insight.rapid7.com/
variables:
region:
default: us
description: Insight API region
security: []
tags:
- name: Health Metrics
description: An API used to retrieve health metrics of an organization.
paths:
/idr/v1/health-metrics:
get:
tags:
- Health Metrics
summary: Retrieve health metrics by org
description: Retrieve paginated health metrics for the given org. In the event of a 207 response, there may be two additional metadata fields in the response. 'failed_to_load' contains the the resource types that did not successfully load. 'unlicensed_resource_types' contains resource types that were requested, but for which the org does not have access to.
operationId: getMetrics
parameters:
- name: index
in: query
description: The optional, 0 based index of the page to retrieve. Must be an integer greater than or equal to 0.
required: false
schema:
minimum: 0
type: integer
default: 0
example: 0
- name: size
in: query
description: The optional size of the page to retrieve. Must be an integer greater than 0 or less than or equal to 100.
required: false
schema:
maximum: 100
minimum: 1
type: integer
default: 20
example: 20
- name: resourceTypes
in: query
description: An optional, comma-separated set of resource types. Only resources whose type matches one of the entries in the list are returned. If this parameter is omitted, health metrics with any resource type may be returned.
required: false
schema:
type: string
example: agent,collectors
- name: orgId
in: query
description: Optional organization ID to get metrics for. If not specified, metrics for the user's current organization will be returned. User must have access to the specified organization.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Page'
examples:
Agent:
description: Health metrics for agent resources
value:
data:
- type: agent
rrn: rrn:rapid7:us:customer:12345:agent:678
offline: 5
online: 25
stale: 3
total: 33
metadata:
index: 0
size: 0
total_pages: 20
total_data: 0
Collectors:
description: Health metrics for collector resources
value:
data:
- type: collectors
rrn: rrn:rapid7:us:customer:12345:collector:abc123
id: collector-001
name: Main Collector
state: RUNNING
last_active: '2025-09-18T10:30:00Z'
event_sources_used: 15
max_event_sources: 100
memory_used: 2048
max_memory: 4096
percent_cpu_used: 25.5
metadata:
index: 0
size: 0
total_pages: 20
total_data: 0
Data Exporters:
description: Health metrics for data exporter resources
value:
data:
- type: data_exporters
rrn: rrn:rapid7:us:customer:12345:data_exporter:exporter001
name: Main Data Exporter
state: RUNNING
last_active: '2025-09-18T10:30:00Z'
metadata:
index: 0
size: 0
total_pages: 20
total_data: 0
Event Sources:
description: Health metrics for event source resources
value:
data:
- type: event_sources
rrn: rrn:rapid7:us:customer:12345:event_source:source001
name: Main Event Source
state: ACTIVE
last_active: '2025-09-18T10:30:00Z'
metadata:
index: 0
size: 0
total_pages: 20
total_data: 0
Honeypots:
description: Health metrics for honeypot resources
value:
data:
- type: honeypots
rrn: rrn:rapid7:us:customer:12345:honeypot:honeypot001
id: honeypot-001
name: Main Honeypot
state: ACTIVE
last_active: '2025-09-18T10:30:00Z'
memory_used: 512
max_memory: 1024
percent_cpu_used: 10.5
metadata:
index: 0
size: 0
total_pages: 20
total_data: 0
Orchestrator:
description: Health metrics for orchestrator resource
value:
data:
- type: orchestrator
rrn: rrn:rapid7:us:customer:12345:orchestrator:orch001
name: Main Orchestrator
state: RUNNING
last_active: '2025-09-18T10:30:00Z'
cpu_used: 35.8
memory_used: 3072
max_memory: 6144
storage_used: 20971520
max_storage: 52428800
metadata:
index: 0
size: 0
total_pages: 20
total_data: 0
Scan Engines:
description: Health metrics for scan engine resources
value:
data:
- type: scan_engines
rrn: rrn:rapid7:us:customer:12345:scan_engine:engine001
name: Main Scan Engine
state: RUNNING
storage_used: 52428800
max_storage: 104857600
last_active: '2025-09-18T10:30:00Z'
memory_used: 4096
max_memory: 8192
percent_cpu_used: 45.2
metadata:
index: 0
size: 0
total_pages: 20
total_data: 0
Sensors:
description: Health metrics for sensor resources
value:
data:
- type: sensors
rrn: rrn:rapid7:us:customer:12345:sensor:sensor001
name: Main Sensor
state: ACTIVE
health_status:
- OK
- MONITORING
storage_used: 15728640
max_storage: 104857600
last_active: '2025-09-18T10:30:00Z'
memory_used: 1024
max_memory: 2048
percent_cpu_used: 15.2
drop_rate: 0.01
metadata:
index: 0
size: 0
total_pages: 20
total_data: 0
'207':
description: Multi-Status
content:
application/json:
schema:
$ref: '#/components/schemas/Page'
examples:
Agent:
description: Health metrics for agent resources
value:
data:
- type: agent
rrn: rrn:rapid7:us:customer:12345:agent:678
offline: 5
online: 25
stale: 3
total: 33
metadata:
index: 0
size: 0
total_pages: 20
total_data: 0
Collectors:
description: Health metrics for collector resources
value:
data:
- type: collectors
rrn: rrn:rapid7:us:customer:12345:collector:abc123
id: collector-001
name: Main Collector
state: RUNNING
last_active: '2025-09-18T10:30:00Z'
event_sources_used: 15
max_event_sources: 100
memory_used: 2048
max_memory: 4096
percent_cpu_used: 25.5
metadata:
index: 0
size: 0
total_pages: 20
total_data: 0
Data Exporters:
description: Health metrics for data exporter resources
value:
data:
- type: data_exporters
rrn: rrn:rapid7:us:customer:12345:data_exporter:exporter001
name: Main Data Exporter
state: RUNNING
last_active: '2025-09-18T10:30:00Z'
metadata:
index: 0
size: 0
total_pages: 20
total_data: 0
Event Sources:
description: Health metrics for event source resources
value:
data:
- type: event_sources
rrn: rrn:rapid7:us:customer:12345:event_source:source001
name: Main Event Source
state: ACTIVE
last_active: '2025-09-18T10:30:00Z'
metadata:
index: 0
size: 0
total_pages: 20
total_data: 0
Honeypots:
description: Health metrics for honeypot resources
value:
data:
- type: honeypots
rrn: rrn:rapid7:us:customer:12345:honeypot:honeypot001
id: honeypot-001
name: Main Honeypot
state: ACTIVE
last_active: '2025-09-18T10:30:00Z'
memory_used: 512
max_memory: 1024
percent_cpu_used: 10.5
metadata:
index: 0
size: 0
total_pages: 20
total_data: 0
Orchestrator:
description: Health metrics for orchestrator resource
value:
data:
- type: orchestrator
rrn: rrn:rapid7:us:customer:12345:orchestrator:orch001
name: Main Orchestrator
state: RUNNING
last_active: '2025-09-18T10:30:00Z'
cpu_used: 35.8
memory_used: 3072
max_memory: 6144
storage_used: 20971520
max_storage: 52428800
metadata:
index: 0
size: 0
total_pages: 20
total_data: 0
Scan Engines:
description: Health metrics for scan engine resources
value:
data:
- type: scan_engines
rrn: rrn:rapid7:us:customer:12345:scan_engine:engine001
name: Main Scan Engine
state: RUNNING
storage_used: 52428800
max_storage: 104857600
last_active: '2025-09-18T10:30:00Z'
memory_used: 4096
max_memory: 8192
percent_cpu_used: 45.2
metadata:
index: 0
size: 0
total_pages: 20
total_data: 0
Sensors:
description: Health metrics for sensor resources
value:
data:
- type: sensors
rrn: rrn:rapid7:us:customer:12345:sensor:sensor001
name: Main Sensor
state: ACTIVE
health_status:
- OK
- MONITORING
storage_used: 15728640
max_storage: 104857600
last_active: '2025-09-18T10:30:00Z'
memory_used: 1024
max_memory: 2048
percent_cpu_used: 15.2
drop_rate: 0.01
metadata:
index: 0
size: 0
total_pages: 20
total_data: 0
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Insufficient Permissions
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Entity Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'502':
description: Bad Gateway
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'503':
description: Service Unavailable
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'504':
description: Gateway Timeout
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
components:
schemas:
PageMetadata:
required:
- index
- size
- total_data
- total_pages
type: object
properties:
index:
type: integer
description: 'The 0 based index of the page retrieved. '
format: int32
example: 0
size:
type: integer
description: 'The size of the page requested. '
format: int32
example: 20
total_pages:
type: integer
description: 'The total number of pages available with the given filter parameters. '
format: int32
example: 1
total_data:
type: integer
description: 'The total number of results available with the given filter parameters. '
format: int64
example: 15
description: The pagination parameters used to generate this page result. Depending on the API, additional parameters may be dynamically present.
ErrorResponse:
required:
- message
type: object
properties:
message:
type: string
description: A human-readable message describing the error that occurred.
example: A human-readable message describing the error that occurred.
correlation_id:
type: string
description: An identifier that uniquely identifies the failed request.
example: 6b6503c8-2da9-41c0-94cb-2f34069e00cd
Page:
required:
- data
- metadata
type: object
properties:
data:
type: array
description: The list of data that matches the pagination parameters. If no results match this will be an empty list.
items:
type: object
description: The list of data that matches the pagination parameters. If no results match this will be an empty list.
metadata:
$ref: '#/components/schemas/PageMetadata'
externalDocs:
description: Product docs
url: https://insightidr.help.rapid7.com/docs