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 Asset Discovery API

Resources for managing and viewing the mechanisms used to automatically discover assets.

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

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

This API exposes 10 operations across 7 paths, and defines 17 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.

10 operations 7 paths 17 schemas 1 DELETE5 GET3 POST1 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 10

Across 7 paths, the API surfaces 10 operations — 1 DELETE, 5 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Asset Discovery 10

Resources for managing and viewing the mechanisms used to automatically discover assets.

GET
/api/3/discovery_connections
Discovery Connections
getDiscoveryConnections 3 params → 200401404500503
GET
/api/3/discovery_connections/{id}
Discovery Connection
getDiscoveryConnection 1 param → 200401404500503
POST
/api/3/discovery_connections/{id}/connect
Discovery Connection Reconnect
reconnectDiscoveryConnection 1 param → 200400401500503
GET
/api/3/sonar_queries
Sonar Queries
getSonarQueries → 200401404500503
POST
/api/3/sonar_queries
Sonar Queries
createSonarQuery 1 param → 200400401500503
POST
/api/3/sonar_queries/search
Sonar Query Search
sonarQuerySearch 1 param → 200400401500503
GET
/api/3/sonar_queries/{id}
Sonar Query
getSonarQuery 1 param → 200401404500503
PUT
/api/3/sonar_queries/{id}
Sonar Query
updateSonarQuery 2 params → 200400401404500503
DELETE
/api/3/sonar_queries/{id}
Sonar Query
deleteSonarQuery 1 param → 200401404500503
GET
/api/3/sonar_queries/{id}/assets
Sonar Query Assets
getSonarQueryAssets 1 param → 200401404500503

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are DiscoveryConnection (21 properties), SonarCriterion (5 properties), PageInfo (4 properties), SonarQuery (4 properties). Each schema is shown below with its type and property counts.

Link
object
2 properties
DiscoveryAsset
object
3 properties
BadRequestError
object
3 properties 1 required
Resources«SonarQuery»
object
2 properties
UnauthorizedError
object
3 properties 1 required
SonarQuery
object
4 properties
DiscoveryConnection
object
21 properties
Resources«DiscoveryAsset»
object
2 properties
SonarCriteria
object
1 property
Links
object
1 property
ServiceUnavailableError
object
3 properties 1 required
PageInfo
object
4 properties
NotFoundError
object
3 properties 1 required
CreatedReference«DiscoveryQueryID,Link»
object
2 properties
InternalServerError
object
3 properties 1 required
PageOf«DiscoveryConnection»
object
3 properties
SonarCriterion
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rapid7-asset-discovery-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 Group API
Rapid7 Assets API
Rapid7 Attachments API
Rapid7 Attack Templates API
Rapid7 Blackouts API