Defines the schema for an alert tag.
| API Endpoints | /resources/v2.1/enrichments-config/tags/ /resources/v2.1/enrichments-config/tags/{tag_name} |
| Supported Methods | POST, GET, PATCH, DELETE |
Parameters
The Alert Tag object schema includes the following attributes:
| Attribute | Description | Type | Example |
|---|---|---|---|
| name | Tag name in BigPanda. | String | “region” |
| created_by | The unique ID associated with the user who created the tag. | String | "60c5238222fa55553d93d555" |
| created_at | The Unix epoch time when the tag was created (in seconds). | Timestamp | 1635260171 |
| updated_by | The unique ID associated with the user who last updated the tag. | String | "60c5238222fa55553d93d555" |
| updated_at | The Unix epoch time when the tag was last updated (in seconds). | Timestamp | 1635260171 |
| description | A brief summary of the tag | String | "line of business" |
| active | Whether the tag should be applied to incoming alerts. | Boolean | true |
| enrichments | List of automatic enrichment items configured for this tag. Items are listed in their run order. | Array of Objects | [ { "type": "extraction", "active": true, "when": {}, "config": { "source": "host", "destination": "tag_name", "regex": "(.*)", "template": null }, "note": null }, { "type": "composition", "active": true, "when": {}, "config": { "destination": "tag_name", "value": "val-${host6666}" }, "note": "wiki.com" } ] |