Skip to main content
GET
/
tags
/
{tagId}
Retrieve a tag definition
curl --request GET \
  --url https://v1.api.altostrat.io/tags/{tagId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "tag_01E8Z4Q6J7B6A5P4E3D2C1B0A9",
  "key": "Region",
  "color": "#3F51B5",
  "mandatory_on": [
    "site"
  ],
  "created_at": "2025-10-29T12:00:00Z",
  "updated_at": "2025-10-29T12:30:00Z",
  "values": [
    {
      "tag_id": "tag_01E8Z4Q6J7B6A5P4E3D2C1B0A9",
      "correlation_id": "site_9b52d930f4324c0abac04c12dff85544",
      "correlation_type": "site",
      "value": "APAC",
      "created_at": "2025-10-29T13:00:00Z",
      "updated_at": "2025-10-29T13:00:00Z"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://altostrat.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

A bearer token is required for all API requests.

Path Parameters

​
tagId
string
required

The unique identifier for the tag definition.

Response

The requested tag definition.

​
id
string

The unique identifier for the tag definition.

Example:

"tag_01E8Z4Q6J7B6A5P4E3D2C1B0A9"

​
key
string

The display name for the tag category (e.g., "Region", "Priority").

Example:

"Region"

​
color
string

A hex color code used for UI display.

Example:

"#3F51B5"

​
mandatory_on
enum<string>[]

A list of resource types where this tag must be applied.

The type of resource being correlated.

Available options:
site,
user,
wan,
account
​
created_at
string<date-time>

The timestamp when the tag definition was created.

Example:

"2025-10-29T12:00:00Z"

​
updated_at
string<date-time>

The timestamp when the tag definition was last updated.

Example:

"2025-10-29T12:30:00Z"

​
values
object[]

A list of all values that have been applied using this tag definition.