Tags mAPI reference
Complete reference documentation for the Tags resource.
Tags
#Tags are named labels in your project's catalog that you can apply to resources to organize them. Tags are project-scoped and are not tied to an environment.
Delete a tag
#Deletes a tag by name.
Endpoint
Path parameters
The name of the tag to delete.
Returns
Upsert a tag
#Creates a tag by name. If a tag with the same name already exists, updates its description and color. Omitted description and color fields are set to null.
Endpoint
Path parameters
The name of the tag to upsert.
Request body
A request to create or update a tag. The tag name is taken from the path. On conflict, omitted description and color fields are set to null.
An optional hex color for the tag (e.g. #3B82F6).
An optional description of the tag.
Returns
Wraps the Tag response under the tag key.
A named tag in a project's resource-tag catalog.
An optional hex color for the tag (e.g. #3B82F6).
The timestamp of when the tag was created.
An optional description of the tag.
The unique name of the tag within a project.
The timestamp of when the tag was last updated.
List tags
#Returns all tags in the project's catalog, ordered by name. Tags are project-scoped and not tied to an environment.
Endpoint
Returns
A list of tags in the project's catalog.
Tags, ordered by name.
An optional hex color for the tag (e.g. #3B82F6).
The timestamp of when the tag was created.
An optional description of the tag.
The unique name of the tag within a project.
The timestamp of when the tag was last updated.
Tag
#A named tag in a project's resource-tag catalog.
Attributes
An optional hex color for the tag (e.g. #3B82F6).
The timestamp of when the tag was created.
An optional description of the tag.
The unique name of the tag within a project.
The timestamp of when the tag was last updated.