Skip to main content
Version: GuardMode 2026.1

Tagging Agent

Agent tagging in GuardMode allows you to organize instances of the GuardMode Agent by tagging them under a shared “campus” value. Tags are added to every alert, both in provider notifications and logs.

In DPX notifications, the tags are displayed as labels. In Syslog notifications, they are added as prefixes to the messages in the following way:

[Tag=<tag1> Tag=<tag2>] <message>

Tag naming requirements​

  • Tags can include letters, numbers, dashes, and underscores
  • All tags are normalized to lowercase.
  • Each tag can be up to 250 alphanumeric characters.

Viewing Agent tags​

Tip.

GuardMode Agent tags can be managed using REST API or the CLI.

Viewing Agent tags using REST API​

To view Agent Tags, send a GET request to /settings/tags.

POST "/settings/tags"

The response includes IDs for each tag. The collection is empty by default.

Viewing Agent tags using CLI​

To view Agent Tags using the CLI:

cd /opt/catalogic/guard-mode/agent
./Catalogic.GuardMode.Agent config list tag

Adding tags​

Adding tags using REST API​

To add a tag to GuardMode Agent, send a POST request to /settings/tags:

POST "/settings/tags"

You need to specify the tag name in the request body in the following way:

{
    "tag": "tag name"
}
Attention!

Do not add the same tag twice.

Adding tags using CLI​

To add a tag to GuardMode Agent using the CLI:

cd /opt/catalogic/guard-mode/agent
sudo ./Catalogic.GuardMode.Agent config add tag <name>

Removing tags​

Removing tags using REST API​

Delete a tag by sending a DELETE request to /settings/tags/{id}:

DELETE "/settings/tags/{id}"

The tag ID can be obtained from the GET request response to the same endpoint.

Removing tags using CLI​

To remove a tag to GuardMode Agent using the CLI:

cd /opt/catalogic/guard-mode/agent
sudo ./Catalogic.GuardMode.Agent config remove tag <tag_ID>