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

Resources and operations for managing tags.

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

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

This API exposes 21 operations across 9 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.

21 operations 9 paths 17 schemas 7 DELETE6 GET1 POST7 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 21

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

Tag 21

Resources and operations for managing tags.

GET
/api/3/tags
Tags
getTags 5 params → 200401404500503
POST
/api/3/tags
Tags
createTag 1 param → 201400401500503
GET
/api/3/tags/{id}
Tag
getTag 1 param → 200401404500503
PUT
/api/3/tags/{id}
Tag
updateTag 2 params → 200400401404500503
DELETE
/api/3/tags/{id}
Tag
deleteTag 1 param → 200401404500503
GET
/api/3/tags/{id}/asset_groups
Tag Asset Groups
getTagAssetGroups 1 param → 200401404500503
PUT
/api/3/tags/{id}/asset_groups
Tag Asset Groups
setTaggedAssetGroups 2 params → 200400401404500503
DELETE
/api/3/tags/{id}/asset_groups
Tag Asset Groups
untagAllAssetGroups 1 param → 200401404500503
PUT
/api/3/tags/{id}/asset_groups/{assetGroupId}
Tag Asset Group
tagAssetGroup 2 params → 200400401404500503
DELETE
/api/3/tags/{id}/asset_groups/{assetGroupId}
Tag Asset Group
untagAssetGroup 2 params → 200401404500503
GET
/api/3/tags/{id}/assets
Tag Assets
getTaggedAssets 1 param → 200401404500503
PUT
/api/3/tags/{id}/assets/{assetId}
Tag Asset
tagAsset 2 params → 200400401404500503
DELETE
/api/3/tags/{id}/assets/{assetId}
Tag Asset
untagAsset 2 params → 200401404500503
GET
/api/3/tags/{id}/search_criteria
Tag Search Criteria
getTagSearchCriteria 1 param → 200401404500503
PUT
/api/3/tags/{id}/search_criteria
Tag Search Criteria
updateTagSearchCriteria 2 params → 200400401404500503
DELETE
/api/3/tags/{id}/search_criteria
Tag Search Criteria
removeTagSearchCriteria 1 param → 200401404500503
GET
/api/3/tags/{id}/sites
Tag Sites
getTaggedSites 1 param → 200401404500503
PUT
/api/3/tags/{id}/sites
Tag Sites
setTaggedSites 2 params → 200400401404500503
DELETE
/api/3/tags/{id}/sites
Tag Sites
removeTaggedSites 1 param → 200401404500503
PUT
/api/3/tags/{id}/sites/{siteId}
Tag Site
tagSite 2 params → 200400401404500503
DELETE
/api/3/tags/{id}/sites/{siteId}
Tag Site
untagSite 2 params → 200401404500503

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are Tag (9 properties), SwaggerSearchCriteriaFilter (6 properties), PageInfo (4 properties), BadRequestError (3 properties). Each schema is shown below with its type and property counts.

BadRequestError
object
3 properties 1 required
UnauthorizedError
object
3 properties 1 required
SearchCriteria
object
2 properties
ReferencesWith«SiteID,Link»
object
2 properties
TagLink
object
2 properties
ReferencesWith«AssetGroupID,Link»
object
2 properties
Links
object
1 property
Tag
object
9 properties 2 required
ServiceUnavailableError
object
3 properties 1 required
PageOf«Tag»
object
3 properties
SwaggerSearchCriteriaFilter
object
6 properties
NotFoundError
object
3 properties 1 required
TaggedAssetReferences
object
2 properties
PageInfo
object
4 properties
ReferenceWith«TagID,Link»
object
2 properties
Link
object
2 properties
InternalServerError
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rapid7-tag-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