The Alert Enrichments V2.1 API allows you to programmatically create custom tags and enrichment items that add contextual information to alerts. It supports the mapping enrichment technique, which creates alert custom tags by looking up values in a data mapping table.

Use the Alert Enrichment V2.1 API to define alert tags and enrichment maps to add vital context to ongoing alerts.

Read more about how alerts are contextualized and the potential correlation and automation possibilities of alert enrichment in the Data Engineering documentation.

With the Alert Enrichments V2.1 API you’ll have more options for leveraging the API to enrich and contextualize alerts.

API Improvements

Improved composition and extraction enrichment item functionality and features
Alert tags can now be duplicated, marked inactive, and have a description
Mapping tables now automatically enrich existing alert tags
Mapping enrichment items can be reordered on a per-tag basis
Enabling future audit-log functionality
Bulk operations now available for enrichment items

In order to leverage these improved capabilities, your organization will need to update your calls to leverage the new endpoints.

Relevant Permissions

Roles with the following permissions can access the Alert Enrichment API:

Permission	Description
`Enrichments_Read` `Enrichments_jobs_Read`	Read only - make GET calls using the Enrichments API.
`Enrichments_Full_Access` `Enrichments_jobs_Full_Access`	Full access - use the Enrichments API to view and define mapping enrichments.

To learn more about how BigPanda's permissions work, see the RBAC - Role Based Access Control guide.

Preparing for Migration

Migrating to the Alert Enrichment V2.1 API is a simple, seamless process. During the initial migration phase, you will have access to the V2.0 API as well as the new V2.1.

Before beginning migration, review all manual and automated processes that leverage the existing Alert Enrichment APIs. This includes any mapping enrichment APIs leveraging the V1.0 and V2.0 Enrichment API.

If you'd like assistance migrating your processes, reach out to your BigPanda Account Team.

Simple Migration

If you are only using the Alert Enrichment V1 API to manage mapping enrichments, the migration process will require only a few steps:

Change the endpoint name attached to Mapping Enrichment calls to the new /v2.1/mapping-enrichment/ endpoint
Validate payload format matches the new requirements
Test an enrichment map to ensure it is uploading correctly
(Optional) If choosing to implement API management of composition and extraction tags, use the new V2.1 endpoints and JSON payload formats.

Complex Migration

If you are using the Enrichment V2.0 API to manage composition and extraction enrichments, the migration process will require a few additional updates:

Change the endpoint name attached to all enrichment calls to the new endpoints:

/v2.0/alert-enrichments (mapping type) --> /v2.1/mapping-enrichment
/v2.0/alert-enrichments (non-mapping type) --> /v2.1/enrichments-config/tags/<TAG_NAME>/enrichments

Validate payload format matches the new requirements

The object payload for Tag Rules or Enrichment Items is changing from a single object to an array of objects. Composition and extraction enrichments will be nested within the enrichment array.

{
     "name": "tag_name", 
     "active": true,
     "description": "", 
     "enrichments": [    
      {
        "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"
    }
  ]
}

Test each enrichment and call type to ensure it is functioning correctly