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 API

Resources and operations for managing assets. Assets can be created under the Site Assets resource.

Rapid7 Asset 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. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 25 operations across 23 paths, and defines 47 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.

25 operations 23 paths 47 schemas 2 DELETE20 GET2 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 25

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

Asset 25

Resources and operations for managing assets. Assets can be created under the Site Assets resource.

GET
/api/3/assets
Assets
getAssets 3 params → 200401404500503
POST
/api/3/sites/{id}/assets
Assets
createAsset 2 params → 200201400401500503
POST
/api/3/assets/search
Asset Search
findAssets 4 params → 200400401500503
GET
/api/3/assets/{id}
Asset
getAsset 1 param → 200401404500503
DELETE
/api/3/assets/{id}
Asset
deleteAsset 1 param → 200401404500503
GET
/api/3/assets/{id}/databases
Asset Databases
getAssetDatabases 1 param → 200401404500503
GET
/api/3/assets/{id}/files
Asset Files
getAssetFiles 1 param → 200401404500503
GET
/api/3/assets/{id}/services
Asset Services
getAssetServices 1 param → 200401404500503
GET
/api/3/assets/{id}/services/{protocol}/{port}
Asset Service
getAssetService 3 params → 200401404500503
GET
/api/3/assets/{id}/services/{protocol}/{port}/configurations
Asset Service Configurations
getAssetServiceConfigurations 3 params → 200401404500503
GET
/api/3/assets/{id}/services/{protocol}/{port}/databases
Asset Service Databases
getAssetServiceDatabases 3 params → 200401404500503
GET
/api/3/assets/{id}/services/{protocol}/{port}/user_groups
Asset Service User Groups
getAssetServiceUserGroups 3 params → 200401404500503
GET
/api/3/assets/{id}/services/{protocol}/{port}/users
Asset Service Users
getAssetServiceUsers 3 params → 200401404500503
GET
/api/3/assets/{id}/services/{protocol}/{port}/web_applications
Asset Service Web Applications
getAssetServiceWebApplications 3 params → 200401404500503
GET
/api/3/assets/{id}/services/{protocol}/{port}/web_applications/{webApplicationId}
Asset Service Web Application
getAssetServiceWebApplication 4 params → 200401404500503
GET
/api/3/assets/{id}/software
Asset Software
getAssetSoftware 1 param → 200401404500503
GET
/api/3/assets/{id}/tags
Asset Tags
getAssetTags 1 param → 200401404500503
PUT
/api/3/assets/{id}/tags/{tagId}
Asset Tag
addAssetTag 2 params → 200400401404500503
DELETE
/api/3/assets/{id}/tags/{tagId}
Asset Tag
removeAssetTag 2 params → 200401404500503
GET
/api/3/assets/{id}/user_groups
Asset User Groups
getAssetUserGroups 1 param → 200401404500503
GET
/api/3/assets/{id}/users
Asset Users
getAssetUsers 1 param → 200401404500503
GET
/api/3/operating_systems
Operating Systems
getOperatingSystems 3 params → 200401404500503
GET
/api/3/operating_systems/{id}
Operating System
getOperatingSystem 1 param → 200401404500503
GET
/api/3/software
Software
getSoftwares 3 params → 200401404500503
GET
/api/3/software/{id}
Software
getSoftware 1 param → 200401404500503

Schemas 47

The contract defines 47 schemas that model the data the API accepts and returns. The most detailed are AssetCreate (27 properties), Asset (24 properties), Service (13 properties), SoftwareCpe (13 properties). Each schema is shown below with its type and property counts.

File
object
4 properties 2 required
ReferenceWithEndpointIDLink
object
3 properties
Configuration
object
2 properties 1 required
UniqueId
object
2 properties 1 required
AssetHistory
object
7 properties
ReferencesWith«WebApplicationID,Link»
object
2 properties
SwaggerSearchCriteriaFilter
object
6 properties
OperatingSystem
object
11 properties
NotFoundError
object
3 properties 1 required
Resources«UserAccount»
object
2 properties
Resources«Configuration»
object
2 properties
PageOf«Asset»
object
3 properties
InternalServerError
object
3 properties 1 required
Resources«AssetTag»
object
2 properties
Database
object
3 properties 1 required
GroupAccount
object
2 properties 1 required
Links
object
1 property
PageOf«Software»
object
3 properties
Resources«Database»
object
2 properties
HostName
object
2 properties 1 required
CreatedOrUpdatedReference
object
2 properties
WebApplication
object
4 properties
UserAccount
object
3 properties
TagAssetSource
object
3 properties
UnauthorizedError
object
3 properties 1 required
PageOf«OperatingSystem»
object
3 properties
SearchCriteria
object
2 properties
AssetTag
object
10 properties 2 required
Address
object
2 properties
ServiceLink
object
4 properties
Resources«GroupAccount»
object
2 properties
ServiceUnavailableError
object
3 properties 1 required
Resources«File»
object
2 properties
ReferencesWith«ReferenceWithEndpointIDLink,ServiceLink»
object
2 properties
Resources«Software»
object
2 properties
BadRequestError
object
3 properties 1 required
Software
object
9 properties
WebPage
object
3 properties
AssetCreate
object
27 properties 1 required
CreatedReference
object
2 properties
AssetVulnerabilities
object
6 properties
SoftwareCpe
object
13 properties 1 required
PageInfo
object
4 properties
Asset
object
24 properties
OperatingSystemCpe
object
13 properties 1 required
Service
object
13 properties 2 required
Link
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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