Defines the schema for an enrichment.
API Endpoint |
|
---|---|
Supported Methods |
|
Parameters
The Enrichments
object schema includes the following attributes:
Attribute | Description | Example |
---|---|---|
active | Whether the enrichment is applied to all incoming alert data. |
|
id | System-generated unique identifier for the enrichment. |
|
version | Internal version number of the current data mapping table for this enrichment. This number is incremented automatically each time the table is updated. |
|
type | Enrichment technique used to create custom tags ( |
|
config | Configuration details associated with the enrichment technique. For a mapping enrichment, this attribute contains a description of the data mapping table. Attributes:
|
Map Configuration Fields
The following attributes describe how to enrich alerts based on a given data mapping table.
Attribute | Description | Example |
---|---|---|
title | Column name in the data mapping table. |
|
type | How data in the column is used in the enrichment process: |
|
tag_name | (Optional) Override the column name with a different tag name in BigPanda. | `"tag_name": "check" |
override_existing | (Optional) Whether to override an existing tag with this value, if applicable. |
|
`