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

Tags are customer-defined labels that can be used for a variety of purposes. The management of Tags is performed by this API, and other APIs facilitate applying these Tags to other resources. These applied Tags can then be used in Search queries submitted to the Search API to aid in data segregation for customer-specific problems. Tags have a unique name constraint, and therefore duplicate names will not be accepted.

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

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

This API exposes 5 operations across 2 paths, and defines 9 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.

5 operations 2 paths 9 schemas 1 DELETE2 GET1 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 5

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

Tags 5

Tags are customer-defined labels that can be used for a variety of purposes. The management of Tags is performed by this API, and other APIs facilitate applying these Tags to othe…

GET
/tags
Get Tags
get-tags 5 params → 415200400401403404500
POST
/tags
Create Tag
create-tag body → 415201400401403404500409
GET
/tags/{tag-id}
Get Tag
get-tag 1 param → 415200400401403404500
PUT
/tags/{tag-id}
Update Tag
update-tag 1 param body → 415200400401403404500409
DELETE
/tags/{tag-id}
Delete Tag
delete-tag 2 params → 415204400401403404500409

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are PageMetadata (6 properties), EntityModelTag (5 properties), Tag (4 properties), ValidationErrors (4 properties). Each schema is shown below with its type and property counts.

ReadOnlyIdResource
object
The ID of the module
1 property
ValidationErrors
object
4 properties
PageTag
object
3 properties
Tag
object
4 properties 1 required
Link
object
4 properties
PageMetadata
object
6 properties
ValidationError
object
3 properties
Error
object
3 properties
EntityModelTag
object
5 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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