Skip to main content
Alert tags help categorize and organize alerts for efficient triage and analysis.

List Alert Tags

Get all alert tags with pagination and filtering.

Query Parameters

page
integer
default:"0"
Page number (zero-based)
size
integer
default:"20"
Number of items per page
sort
string
Sort field and direction (e.g., tagName,asc)

Response

Returns an array of alert tag objects.
id
integer
Tag ID
tagName
string
Tag name
tagColor
string
Hex color code for tag display
systemOwner
boolean
Whether tag is system-owned (cannot be deleted)
curl -X GET "https://your-utmstack-instance.com/api/utm-alert-tags?page=0&size=20" \
  -H "Authorization: Bearer eyJhbGciOiJIUzUxMiJ9..."
[
  {
    "id": 1,
    "tagName": "false-positive",
    "tagColor": "#28a745",
    "systemOwner": true
  },
  {
    "id": 2,
    "tagName": "high-priority",
    "tagColor": "#dc3545",
    "systemOwner": false
  },
  {
    "id": 3,
    "tagName": "investigated",
    "tagColor": "#007bff",
    "systemOwner": false
  }
]

Get Alert Tag

Get a specific alert tag by ID.

Path Parameters

id
integer
required
Tag ID
curl -X GET https://your-utmstack-instance.com/api/utm-alert-tags/1 \
  -H "Authorization: Bearer eyJhbGciOiJIUzUxMiJ9..."
{
  "id": 1,
  "tagName": "false-positive",
  "tagColor": "#28a745",
  "systemOwner": true
}

Create Alert Tag

Create a new alert tag.

Request Body

tagName
string
required
Unique tag name
tagColor
string
required
Hex color code (e.g., #ff0000)
curl -X POST https://your-utmstack-instance.com/api/utm-alert-tags \
  -H "Authorization: Bearer eyJhbGciOiJIUzUxMiJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "tagName": "ransomware",
    "tagColor": "#ff0000"
  }'
{
  "id": 10,
  "tagName": "ransomware",
  "tagColor": "#ff0000",
  "systemOwner": false
}

Update Alert Tag

Update an existing alert tag.

Request Body

id
integer
required
Tag ID to update
tagName
string
required
Tag name
tagColor
string
required
Hex color code
curl -X PUT https://your-utmstack-instance.com/api/utm-alert-tags \
  -H "Authorization: Bearer eyJhbGciOiJIUzUxMiJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "id": 10,
    "tagName": "ransomware-detected",
    "tagColor": "#cc0000"
  }'
{
  "id": 10,
  "tagName": "ransomware-detected",
  "tagColor": "#cc0000",
  "systemOwner": false
}

Delete Alert Tag

Delete an alert tag. System-owned tags cannot be deleted.

Path Parameters

id
integer
required
Tag ID to delete
curl -X DELETE https://your-utmstack-instance.com/api/utm-alert-tags/10 \
  -H "Authorization: Bearer eyJhbGciOiJIUzUxMiJ9..."

Build docs developers (and LLMs) love