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

Resources and operations for managing asset groups.

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

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

22 operations 10 paths 36 schemas 6 DELETE7 GET1 POST8 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 22

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

Asset Group 22

Resources and operations for managing asset groups.

GET
/api/3/agents
Agents
getAgents 3 params → 200401404500503
GET
/api/3/asset_groups
Asset Groups
getAssetGroups 5 params → 200401404500503
POST
/api/3/asset_groups
Asset Groups
createAssetGroup 1 param → 201400401500503
GET
/api/3/asset_groups/{id}
Asset Group
getAssetGroup 1 param → 200401404500503
PUT
/api/3/asset_groups/{id}
Asset Group
updateAssetGroup 2 params → 200400401404500503
DELETE
/api/3/asset_groups/{id}
Asset Group
deleteAssetGroup 1 param → 200401404500503
GET
/api/3/asset_groups/{id}/assets
Asset Group Assets
getAssetGroupAssets 1 param → 200401404500503
PUT
/api/3/asset_groups/{id}/assets
Asset Group Assets
updateAssetGroupAssets 2 params → 200400401404500503
DELETE
/api/3/asset_groups/{id}/assets
Asset Group Assets
removeAllAssetsFromAssetGroup 1 param → 200401404500503
PUT
/api/3/asset_groups/{id}/assets/{assetId}
Asset Group Asset
addAssetToAssetGroup 2 params → 200400401404500503
DELETE
/api/3/asset_groups/{id}/assets/{assetId}
Asset Group Asset
removeAssetFromAssetGroup 2 params → 200401404500503
GET
/api/3/asset_groups/{id}/search_criteria
Asset Group Search Criteria
getAssetGroupSearchCriteria 1 param → 200401404500503
PUT
/api/3/asset_groups/{id}/search_criteria
Asset Group Search Criteria
setAssetGroupSearchCriteria 2 params → 200400401404500503
GET
/api/3/asset_groups/{id}/tags
Asset Group Tags
getAssetGroupTags 1 param → 200401404500503
PUT
/api/3/asset_groups/{id}/tags
Asset Group Tags
setAssetGroupTags 2 params → 200400401404500503
DELETE
/api/3/asset_groups/{id}/tags
Asset Group Tags
removeAllAssetGroupTags 1 param → 200401404500503
PUT
/api/3/asset_groups/{id}/tags/{tagId}
Resources and operations for managing asset groups.
addAssetGroupTag 2 params → 200400401404500503
DELETE
/api/3/asset_groups/{id}/tags/{tagId}
Resources and operations for managing asset groups.
removeAssetGroupTag 2 params → 200401404500503
GET
/api/3/asset_groups/{id}/users
Asset Group Users
getAssetGroupUsers 1 param → 200401404500503
PUT
/api/3/asset_groups/{id}/users
Asset Group Users
setAssetGroupUsers 2 params → 200400401404500503
PUT
/api/3/asset_groups/{id}/users/{userId}
Asset Group User
addAssetGroupUser 2 params → 200400401404500503
DELETE
/api/3/asset_groups/{id}/users/{userId}
Asset Group User
removeAssetGroupUser 2 params → 200401404500503

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are Agent (26 properties), Service (13 properties), SoftwareCpe (13 properties), OperatingSystemCpe (13 properties). Each schema is shown below with its type and property counts.

File
object
4 properties 2 required
Configuration
object
2 properties 1 required
UniqueId
object
2 properties 1 required
AssetHistory
object
7 properties
SwaggerSearchCriteriaFilter
object
6 properties
OperatingSystem
object
11 properties
NotFoundError
object
3 properties 1 required
InternalServerError
object
3 properties 1 required
Database
object
3 properties 1 required
PageOf«AssetGroup»
object
3 properties
GroupAccount
object
2 properties 1 required
Links
object
1 property
ReferencesWith«UserID,Link»
object
2 properties
HostName
object
2 properties 1 required
PageOf«Agent»
object
3 properties
WebApplication
object
4 properties
UserAccount
object
3 properties
ReferencesWith«TagID,Link»
object
2 properties
UnauthorizedError
object
3 properties 1 required
SearchCriteria
object
2 properties
Vulnerabilities
object
4 properties
Address
object
2 properties
ServiceUnavailableError
object
3 properties 1 required
Agent
object
26 properties 1 required
AssetGroup
object
9 properties 2 required
ReferencesWith«AssetID,Link»
object
2 properties
BadRequestError
object
3 properties 1 required
Software
object
9 properties
CreatedReference«AssetGroupID,Link»
object
2 properties
WebPage
object
3 properties
AssetVulnerabilities
object
6 properties
SoftwareCpe
object
13 properties 1 required
PageInfo
object
4 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-group-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 Assets API
Rapid7 Attachments API
Rapid7 Attack Templates API
Rapid7 Blackouts API