Alert Tag Object

Defines the schema for an alert tag.

API Endpoints/resources/v2.1/enrichments-config/tags/
/resources/v2.1/enrichments-config/tags/{tag_name}
Supported MethodsPOST, GET, PATCH, DELETE

Parameters

The Alert Tag object schema includes the following attributes:

AttributeDescriptionType
nameTag name in BigPanda.String
created_byThe unique ID associated with the user who created the tag.String
created_atThe Unix epoch time when the tag was created (in seconds).Timestamp
updated_byThe unique ID associated with the user who last updated the tag.String
updated_atThe Unix epoch time when the tag was last updated (in seconds).Timestamp
descriptionA brief summary of the tagString
activeWhether the tag should be applied to incoming alerts.Boolean
enrichmentsList of automatic enrichment items configured for this tag. Items are listed in their run order. See the Enrichment Item Object table for details on enrichment object fields.Array of Objects

Sample Return Object:

{
      "name": "tag_name",
      "created_by": "565ee8e0dab117512da3c411",
      "created_at": 1464080054,
      "updated_by": "58d77efa5eafe459163f4211",
      "updated_at": 1641796851,
      "description": "",
      "active": true,
      "enrichments": [
        {
          "id": "191217f6-481d-464e-9f12-3ed846a72b11",
          "type": "composition",
          "active": true,
          "when": {
            "IN": [
              "source_system",
              [
                {
                  "type": "regex",
                  "value": "*"
                }
              ]
            ]
          },
          "version": 1,
          "config": {
            "destination": "source",
            "value": "compttest"
          },
          "created_by": "58d77efa5eafe459163f4211",
          "updated_by": "58d77efa5eafe459163f4211",
          "note": null
        },
        {
          "id": "74092648-393a-4896-b5c4-798ab0f00a11",
          "type": "extraction",
          "active": true,
          "when": {
            "AND": [
              {
                "IN": [
                  "source_system",
                  [
                    "api.test"
                  ]
                ]
              }
            ]
          },
          "version": 1,
          "config": {
            "source": "source",
            "destination": "tag_name",
            "regex": "Erroz: [^\\[]+ \\[[^\\]]+\\][\\. ]?\\[([^\\]^\\.]+)\\..*\\]",
            "template": "$1"
          },
          "created_by": "565ee8e0dab117512da3c411",
          "updated_by": "58d77efa5eafe459163f4211",
          "note": null
        }
      ]
    }