The following provides for the creation, retrieval, and management of tags through the API.
Resource
Description
GET /tags
Action
Retrieves list of tags available to your billing group.
Parameters (Query)
include_archived
If set to true, the response will include archived tags. Default is false.
Values to use: true, false
POST /tags
Action
Creates a new tag.
Parameters (JSON)
tag_name (string)
The name of the tag. Must be less than 30 characters.
Cannot be empty.
description (string)
The description of the tag. Must be less than 120 characters.
Cannot be empty.
color (string)
The color of the tag in hexadecimal format.
Default: #2B7FC7
Must be a valid hex color (e.g., #FF5500 or #F50)
GET /tags/:tag_id
Action
Retrieves a specific tag by ID.
Parameters (Path)
:tag_id
The ID of the tag to retrieve.
PUT /tags/:tag_id
Action
Updates an existing tag.
Parameters (Path)
:tag_id
The ID of the tag to update.
Parameters (JSON)
tag_name (string)
The new name of the tag. Must be less than 30 characters.
Cannot be empty.
description (string)
The new description of the tag. Must be less than 120 characters.
Cannot be empty.
color (string)
The new color of the tag in hexadecimal format.
Must be a valid hex color (e.g., #FF5500 or #F50)
DELETE /tags/:tag_id
Action
Archives a tag. The tag will be removed from all services and instances but will remain in the system.
Consider renaming a tag to "{Old Name} - Unused" for 30 days before archiving tags entirely.