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.

Adds a new agent tag

POST/settings/tags

Header parameters

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

tag*string

Response

201400409

Tag was successfully added

Body

text/plainapplication/jsontext/json

id*string (uuid)

tag*string

createdAt*string (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/settings/tags', {
    method: 'POST',
    headers: {
      "api-version": "text",
      "Content-Type": "application/json-patch+json"
    },
    body: JSON.stringify({
      "tag": "text"
    }),
});
const data = await response.json();

Response

201400409

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "tag": "text",
  "createdAt": "2024-09-19T16:35:11.208Z"
}

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:

Adds a new agent tag

POST/settings/tags

Header parameters

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

tag*string

Response

201400409

Tag was successfully added

Body

text/plainapplication/jsontext/json

id*string (uuid)

tag*string

createdAt*string (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/settings/tags', {
    method: 'POST',
    headers: {
      "api-version": "text",
      "Content-Type": "application/json-patch+json"
    },
    body: JSON.stringify({
      "tag": "text"
    }),
});
const data = await response.json();

Response

201400409

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "tag": "text",
  "createdAt": "2024-09-19T16:35:11.208Z"
}

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}:

Removes an agent tag

DELETE/settings/tags/{id}

Path parameters

id*string (uuid)

Header parameters

Response

204400

Tag was removed

Request

JavaScriptCurlPython

const response = await fetch('/settings/tags/{id}', {
    method: 'DELETE',
    headers: {
      "api-version": "text"
    },
});
const data = await response.json();

Response

400

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

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>