BigPanda Alert Tags & Enrichment API

Alert tags, enrichment items, mapping enrichment schemas and tables — the largest single resource group, and the one that decides what context an incident carries.

Operations 45

GET /resources/v2.0/alerts-enrichments-jobs/{job_id} Check Status of Upload Job #
POST /resources/alert-enricher/schemas Create Advanced Mapping Schema
GET /resources/alert-enricher/schemas Retrieve All Advanced Mapping Schemas
POST /resources/v2.0/alert-enrichments Create Alert Enrichment Item #
POST /resources/v2.1/enrichments-config/tags Create Alert Tag #
GET /resources/v2.1/enrichments-config/tags Retrieve All Alert Tags #
POST /resources/v2.1/enrichments-config/tags/{alerttag_name}/enrichments Create Enrichment #
DELETE /resources/v2.1/enrichments-config/tags/{alerttag_name}/enrichments Delete Enrichment Item #
PATCH /resources/v2.1/enrichments-config/tags/{alerttag_name}/enrichments Update Enrichment Item #
POST /resources/v2.1/mapping-enrichment Create Mapping Enrichment Schema #
GET /resources/v2.1/mapping-enrichment Retrieve All Mapping Enrichment Schemas #
POST /resources/alert-enricher/schemas/{schema_id}/rules Create Mapping Enrichment Table
PUT /resources/alert-enricher/schemas/{schema_id}/rules Create or Update Map Rows
DELETE /resources/alert-enricher/schemas/{schema_id}/rules Delete Map Rows
GET /resources/alert-enricher/schemas/{schema_id}/rules Retrieve Map Rows
POST /resources/v2.0/alert-enrichments/{mapschema_id}/map Create Mapping Enrichment Table Rows #
GET /resources/v2.0/alert-enrichments/{mapschema_id}/map Retrieve Mapping Enrichment #
PATCH /resources/v2.0/alert-enrichments/{mapschema_id}/map Update Mapping Enrichment Table Rows #
POST /resources/v2.1/mapping-enrichment/{mapschema_id}/map Create mapping enrichment table using CSV #
PATCH /resources/v2.1/mapping-enrichment/{mapschema_id}/map Create, Update, or Delete Mapping Enrichment Row #
GET /resources/v2.1/mapping-enrichment/{mapschema_id}/map Retrieve Mapping Enrichment Table #
DELETE /resources/alert-enricher/schemas/{schema_id} Delete Advanced Mapping Schema
GET /resources/alert-enricher/schemas/{schema_id} Retrieve Advanced Mapping Schema
PUT /resources/alert-enricher/schemas/{schema_id} Update Advanced Mapping Schema
DELETE /resources/v2.0/alert-enrichments/{enrichment_id} Delete Alert Enrichment Item #
GET /resources/v2.0/alert-enrichments/{enrichment_id} Retrieve Alert Enrichment Item #
PATCH /resources/v2.0/alert-enrichments/{enrichment_id} Update Alert Enrichment Item #
DELETE /resources/v2.1/enrichments-config/tags/{alerttag_name} Delete Alert Tag #
GET /resources/v2.1/enrichments-config/tags/{alerttag_name} Retrieve Alert Tag #
PATCH /resources/v2.1/enrichments-config/tags/{alerttag_name} Update Alert Tag Data #
DELETE /resources/alert-enricher/schemas/{schema_id}/rules/{row_id} Delete Mapping Enrichment Row
PATCH /resources/alert-enricher/schemas/{schema_id}/rules/{row_id} Update Mapping Enrichment Row
DELETE /resources/v2.1/mapping-enrichment/{mapschema_id} Delete Mapping Enrichment Schema #
GET /resources/v2.1/mapping-enrichment/{mapschema_id} Retrieve Mapping Enrichment Schema #
PATCH /resources/v2.1/mapping-enrichment/{mapschema_id} Update Mapping Enrichment Schema #
GET /resources/v2.0/enrichments-config/tags List All Alert Tags #
GET /resources/v2.0/enrichments-config/tags/{alerttag_name} List All Enrichment Items of a Tag #
GET /resources/v2.1/alert-enrichments-jobs/{job_id} Retrieve Mapping Table Job Status #
GET /resources/alert-enricher/jobs/{job_id} Retrieve Upload Job Status
GET /resources/v2.0/enrichments-config/tags/{alerttag_name}/order Retrieve enrichment item order #
PUT /resources/v2.0/enrichments-config/tags/{alerttag_name}/order Update Enrichment Items Order #
GET /resources/v2.0/enrichments-config Retrieve tags order #
PUT /resources/v2.0/enrichments-config Update tag order #
PUT /resources/v2.1/enrichments-config Update Alert Tag Order #
PUT /resources/v2.1/enrichments-config/tags/{alerttag_name}/order Update Enrichment Item Order for an Alert Tag #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/bigpanda-alert-enrichment-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

bigpanda-alert-enrichment-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: BigPanda Alert Tags & Enrichment API
  description: BigPanda Alert Tags & Enrichment operations, assembled verbatim from the OpenAPI fragments BigPanda publishes
    on its own API reference at https://api-docs.bigpanda.io/. Each operation carries x-source-url naming the exact provider
    page it was read from. BigPanda hosts each organization in a single data management region (US or EU); send requests to
    the base URL for your region.
  version: 1.0.0
  contact:
    name: BigPanda Support
    url: https://api-docs.bigpanda.io/
  license:
    name: Proprietary
    url: https://www.bigpanda.io/legal/
  x-provenance:
    method: searched
    source: https://api-docs.bigpanda.io/llms.txt
    harvested: '2026-09-04'
    assembly: 'Operations copied verbatim from the per-endpoint OpenAPI 3.0.1 fragments BigPanda publishes at https://api-docs.bigpanda.io/<endpoint>.md.
      Assembly-only normalizations: Apidog x-apidog security metadata stripped, securityScheme type "bearer" corrected to
      type http/scheme bearer, schema name collisions suffixed. No operation, parameter, schema or response was authored by
      API Evangelist.'
    operations: 45
servers:
- url: https://api.bigpanda.io
  description: US Region
- url: https://api.eu.bigpanda.io
  description: EU Region
tags:
- name: Alert Tags & Enrichment
paths:
  /resources/v2.0/alerts-enrichments-jobs/{job_id}:
    get:
      summary: Check Status of Upload Job
      deprecated: false
      description: "Checks the status of an asynchronous job to upload or update a mapping\nenrichment table (Enrichment V2)\n\
        \n> \U0001F6A7 **Authentication**\n> \n> All BigPanda APIs require Bearer Token Authorization in the call headers.\n\
        >\n> This API uses the User API Key type of Authorization token. Your User API Key must be provided in the header,\
        \ prefixed by the word `Bearer`.\n>\n> Example:\n> `Authorization: Bearer [YOUR_USER_API_KEY]`\n"
      operationId: check-status-of-upload-job
      tags:
      - Alert Tags & Enrichment
      parameters:
      - name: job_id
        in: path
        description: System id of the upload job.
        required: true
        example: ''
        schema:
          type: string
          examples:
          - 262762hh2
      responses:
        '200':
          x-apidog-ordering: 0
          description: '200'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/enrichment_item'
          headers: {}
          x-apidog-name: ''
        '404':
          x-apidog-ordering: 1
          description: '404'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generic404response'
          headers: {}
          x-apidog-name: ''
      security:
      - BearerUser13: []
      x-publication-status: live
      x-run-in-apidog: https://app.apidog.com/web/project/1203004/apis/api-38346154-run
      x-source-url: https://api-docs.bigpanda.io/check-status-of-upload-job-38346154e0.md
      x-source-page: Check Status of Upload Job
  /resources/alert-enricher/schemas:
    post:
      summary: Create Advanced Mapping Schema
      deprecated: false
      description: 'Creates an advanced mapping enrichment schema.


        Rate limit: 5 requests per second.


        **Limits:** up to 200 mapping enrichment result tags per map.


        **Manual migration required**


        The advanced capabilities of the Alert Enricher conflict with previous alert enrichment schemas. Reach out to your
        account team and ensure your organization is ready for the Alert Enricher before using these endpoints.'
      tags:
      - Alert Tags & Enrichment
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/advanced_mapping_schema'
            example:
              type: advanced_mapping
              execution_order: '6'
              name: map-schema 5
              config:
                fields:
                - type: query_tag
                  tag_name: offset
                - type: query_tag
                  tag_name: agent
                - type: result_tag
                  tag_name: region
                - type: result_tag
                  tag_name: email
                  groups:
                  - fields:
                    - type: group_tag
                      tag_name: alert_group
                    - type: group_tag
                      tag_name: ticket_active
                    order: 1
                    name: alert_group_ticket_active
                    method: union
                  - fields:
                    - type: group_tag
                      tag_name: alert_group
                    order: 2
                    name: alert_group
                    method: first_match
      responses:
        '201':
          description: Schema created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/advanced_mapping_schema'
          headers: {}
          x-apidog-name: ''
        '400':
          description: Bad request — malformed body or parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-response-v1'
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized — missing or invalid credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-response-v1'
          headers: {}
          x-apidog-name: ''
      security:
      - BearerUser131: []
      x-run-in-apidog: https://app.apidog.com/web/project/1203004/apis/api-39127781-run
      x-source-url: https://api-docs.bigpanda.io/create-advanced-mapping-schema-39127781e0.md
      x-source-page: Create Advanced Mapping Schema
    get:
      summary: Retrieve All Advanced Mapping Schemas
      deprecated: false
      description: 'Lists all advanced mapping enrichment schemas in BigPanda.


        Rate limit: 5 requests per second.'
      tags:
      - Alert Tags & Enrichment
      parameters: []
      responses:
        '200':
          description: List of schemas.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/advanced_mapping_schema'
          headers: {}
          x-apidog-name: ''
        '401':
          description: Unauthorized — missing or invalid credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-response-v1'
          headers: {}
          x-apidog-name: ''
      security:
      - BearerUser131: []
      x-run-in-apidog: https://app.apidog.com/web/project/1203004/apis/api-39127782-run
      x-source-url: https://api-docs.bigpanda.io/retrieve-all-advanced-mapping-schemas-39127782e0.md
      x-source-page: Retrieve All Advanced Mapping Schemas
  /resources/v2.0/alert-enrichments:
    post:
      summary: Create Alert Enrichment Item
      deprecated: false
      description: "Creates a new alert enrichment item (Enrichment V2)\n\n> \U0001F6A7 **Authentication**\n> \n> All BigPanda\
        \ APIs require Bearer Token Authorization in the call headers.\n>\n> This API uses the User API Key type of Authorization\
        \ token. Your User API Key must be provided in the header, prefixed by the word `Bearer`.\n>\n> Example:\n> `Authorization:\
        \ Bearer [YOUR_USER_API_KEY]`\n\n**Rate limit:** 5 requests per second."
      operationId: create-enrichment-1
      tags:
      - Alert Tags & Enrichment
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/enrichment_item'
      responses:
        '200':
          x-apidog-ordering: 0
          description: '200'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/enrichment_item'
          headers: {}
          x-apidog-name: ''
      security:
      - BearerUser13: []
      x-publication-status: live
      x-run-in-apidog: https://app.apidog.com/web/project/1203004/apis/api-37770004-run
      x-source-url: https://api-docs.bigpanda.io/create-alert-enrichment-item-37770004e0.md
      x-source-page: Create Alert Enrichment Item
  /resources/v2.1/enrichments-config/tags:
    post:
      summary: Create Alert Tag
      deprecated: false
      description: "Creates a new tag.\n\n## Authentication\nAll BigPanda APIs require Bearer Token Authorization in the call\
        \ headers.\n\nThis API uses the User API Key type of Authorization token. Your User API Key must be provided in the\
        \ header, prefixed by the word `Bearer`.\n\nExample:\n`Authorization: Bearer [YOUR_USER_API_KEY]`\n\n> \U0001F6A7\
        \ **Config object required**\n> \n> The config object is required when creating an enrichment item. When adding your\
        \ array of enrichment items, make sure to expand the config object and include all required parameters.\n>\n> Different\
        \ fields are required for composition and extraction type enrichments.\n\n## Composition enrichment items\nComposition\
        \ enrichment items are created by defining a value template. The Composition template is a simple formula to populate\
        \ tag value using strings and other tag values.\n\nUse any tag value as a variable, using the format `${<tag_name>}`.\
        \ For example:\n`mywiki.com/${host}/${check}`\n\nSpecial formatting is required for tag values that contain encoded\
        \ characters for URLs. If the tag value contains encoded values for the characters `%`, `+`, or a space, use the format\
        \ `${exact(<tagname>)}` to protect the values from being re-encoded.\n\nComposition configs must include the `source`,\
        \ `destination`, and `value` properties.\n## Extraction enrichment items\n\nExtraction enrichment items are created\
        \ by defining a regular expression (regex formula).\n\nExtraction Regex: The [Regular expression](https://regex101.com/)\
        \ to extract the new tag value from the source tag value.\n- Use a caret `^` to indicate starts with and a dollar\
        \ sign `$` to indicate ends with.\n- Use parentheses to surround the capture group for the extraction. BigPanda uses\
        \ the contents of the first capture group to create the value of the alert enrichment tag.\n- Use a [non-capturing\
        \ group](https://stackoverflow.com/questions/3512471/what-is-a-non-capturing-group-in-regular-expressions) to ignore\
        \ part of the contents.\n\nIf a tag value doesn't match the pattern, the alert is not enriched with the alert enrichment\
        \ item.\n\nExtraction configs must include the `source`, `destination`, and `regex` properties.\n\n**Rate limit:**\
        \ 5 requests per second."
      operationId: create-tag
      tags:
      - Alert Tags & Enrichment
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/alert_tag_object'
            examples:
              extraction:
                value:
                  name: service_name
                  active: true
                  description: Extract service from host
                  enrichments:
                  - type: extraction
                    active: true
                    when:
                      AND:
                      - '=':
                        - status
                        - warning
                      - IN:
                        - source_system
                        - - oim.integration_mcs
                    config:
                      source: host
                      selected_source_system: oim.integration_mcs
                      destination: service_name
                      regex: ^([^-]+)-.*$
                summary: New tag with an extraction rule
              composition:
                value:
                  name: new_service_name
                  active: true
                  description: Set service from a fixed value
                  enrichments:
                  - type: composition
                    active: true
                    when:
                      IN:
                      - source_system
                      - - type: regex
                          value: '*'
                    config:
                      source: oim.feb_oim
                      destination: new_service_name
                      value: somefixedvalue
                    note: Populate a fixed service value
                summary: New tag with a composition rule
      responses:
        '201':
          x-apidog-ordering: 0
          description: '201'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/alert_tag_response'
          headers: {}
          x-apidog-name: ''
      security:
      - BearerUser131: []
      x-publication-status: live
      x-run-in-apidog: https://app.apidog.com/web/project/1203004/apis/api-37770009-run
      x-source-url: https://api-docs.bigpanda.io/create-alert-tag-37770009e0.md
      x-source-page: Create Alert Tag
    get:
      summary: Retrieve All Alert Tags
      deprecated: false
      description: 'List all alert tags configured in BigPanda.


        ## Authentication

        All BigPanda APIs require Bearer Token Authorization in the call headers.


        This API uses the User API Key type of Authorization token. Your User API Key must be provided in the header, prefixed
        by the word `Bearer`.


        Example:

        `Authorization: Bearer [YOUR_USER_API_KEY]`


        **Rate limit:** 5 requests per second.'
      operationId: retrieve-all-tags
      tags:
      - Alert Tags & Enrichment
      parameters: []
      responses:
        '200':
          x-apidog-ordering: 0
          description: '200'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/alert_tag_response'
          headers: {}
          x-apidog-name: ''
      security:
      - BearerUser131: []
      x-publication-status: live
      x-run-in-apidog: https://app.apidog.com/web/project/1203004/apis/api-37770008-run
      x-source-url: https://api-docs.bigpanda.io/retrieve-all-alert-tags-37770008e0.md
      x-source-page: Retrieve All Alert Tags
  /resources/v2.1/enrichments-config/tags/{alerttag_name}/enrichments:
    post:
      summary: Create Enrichment
      deprecated: false
      description: "Creates a new composition or extraction enrichment item for the tag.\n\n## Authentication\nAll BigPanda\
        \ APIs require Bearer Token Authorization in the call headers.\n\nThis API uses the User API Key type of Authorization\
        \ token. Your User API Key must be provided in the header, prefixed by the word `Bearer`.\n\nExample:\n`Authorization:\
        \ Bearer [YOUR_USER_API_KEY]`\n\n> \U0001F6A7 **Config object required**\n> \n> The config object is required when\
        \ creating an enrichment item. When adding your array of enrichment items, make sure to expand the config object and\
        \ include all required parameters.\n>\n> Different fields are required for composition and extraction type enrichments.\n\
        \n## Composition enrichment items\nComposition enrichment items are created by defining a value template. The Composition\
        \ template is a simple formula to populate tag value using strings and other tag values.\n\nUse any tag value as a\
        \ variable, using the format `${<tag_name>}`. For example:\n`mywiki.com/${host}/${check}`\n\nSpecial formatting is\
        \ required for tag values that contain encoded characters for URLs. If the tag value contains encoded values for the\
        \ characters `%`, `+`, or a space, use the format `${exact(<tagname>)}` to protect the values from being re-encoded.\n\
        \nComposition configs must include the `source`, `destination`, and `value` properties.\n## Extraction enrichment\
        \ items\n\nExtraction enrichment items are created by defining a regular expression (regex formula).\n\nExtraction\
        \ Regex: The [Regular expression](https://regex101.com/) to extract the new tag value from the source tag value.\n\
        - Use a caret `^` to indicate starts with and a dollar sign `$` to indicate ends with.\n- Use parentheses to surround\
        \ the capture group for the extraction. BigPanda uses the contents of the first capture group to create the value\
        \ of the alert enrichment tag.\n- Use a [non-capturing group](https://stackoverflow.com/questions/3512471/what-is-a-non-capturing-group-in-regular-expressions)\
        \ to ignore part of the contents.\n\nIf a tag value doesn't match the pattern, the alert is not enriched with the\
        \ alert enrichment item.\n\nExtraction configs must include the `source`, `destination`, and `regex` properties.\n\
        \n**Rate limit:** 5 requests per second."
      operationId: create-tag-rule
      tags:
      - Alert Tags & Enrichment
      parameters:
      - name: alerttag_name
        in: path
        description: Tag name in BigPanda. May be a normalized tag name.
        required: true
        example: ''
        schema:
          type: string
          examples:
          - host
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                enrichments:
                  type: array
                  items:
                    $ref: '#/components/schemas/enrichment_item'
              x-apidog-orders:
              - enrichments
              x-apidog-ignore-properties: []
            examples:
              extraction:
                value:
                  enrichments:
                  - type: extraction
                    active: true
                    when:
                      AND:
                      - '=':
                        - status
                        - warning
                      - IN:
                        - source_system
                        - - oim.datadog_prod
                    config:
                      source: host
                      selected_source_system: oim.datadog_prod
                      destination: service_name
                      regex: ^([^-]+)-.*$
                    note: Extract service from host
                summary: Add an extraction rule
              composition:
                value:
                  enrichments:
                  - type: composition
                    active: true
                    when:
                      IN:
                      - source_system
                      - - type: regex
                          value: '*'
                    config:
                      source: All Systems
                      destination: service_name
                      value: fixedvalue
                    note: Set a fixed service value
                summary: Add a composition rule
      responses:
        '200':
          x-apidog-ordering: 0
          description: '200'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/enrichment_itemresponse'
          headers: {}
          x-apidog-name: ''
        '201':
          x-apidog-ordering: 1
          description: '201'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/enrichment_itemresponse'
          headers: {}
          x-apidog-name: ''
        '400':
          x-apidog-ordering: 2
          description: '400'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generic400response'
          headers: {}
          x-apidog-name: ''
        '404':
          x-apidog-ordering: 3
          description: '404'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generic404response'
          headers: {}
          x-apidog-name: ''
      security:
      - BearerUser131: []
      x-publication-status: live
      x-run-in-apidog: https://app.apidog.com/web/project/1203004/apis/api-37770013-run
      x-source-url: https://api-docs.bigpanda.io/create-enrichment-37770013e0.md
      x-source-page: Create Enrichment
    delete:
      summary: Delete Enrichment Item
      deprecated: false
      description: "Deletes a composition or extraction enrichment item for the tag.\n\n> \U0001F6A7 **Authentication**\n\
        > \n> All BigPanda APIs require Bearer Token Authorization in the call headers.\n>\n> This API uses the User API Key\
        \ type of Authorization token. Your User API Key must be provided in the header, prefixed by the word `Bearer`.\n\
        >\n> Example:\n> `Authorization: Bearer [YOUR_USER_API_KEY]`\n\n**Rate limit:** 5 requests per second."
      operationId: delete-tag-rule
      tags:
      - Alert Tags & Enrichment
      parameters:
      - name: alerttag_name
        in: path
        description: Tag name in BigPanda. May be a normalized tag name.
        required: true
        example: ''
        schema:
          type: string
          examples:
          - host
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                enrichments_ids:
                  type: array
                  items:
                    type: string
              required:
              - enrichments_ids
              x-apidog-orders:
              - enrichments_ids
              x-apidog-ignore-properties: []
      responses:
        '204':
          x-apidog-ordering: 0
          description: '204'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generic204response'
          headers: {}
          x-apidog-name: ''
        '400':
          x-apidog-ordering: 1
          description: '400'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generic400response'
          headers: {}
          x-apidog-name: ''
        '404':
          x-apidog-ordering: 2
          description: '404'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generic404response'
          headers: {}
          x-apidog-name: ''
      security:
      - BearerUser131: []
      x-publication-status: live
      x-run-in-apidog: https://app.apidog.com/web/project/1203004/apis/api-37770014-run
      x-source-url: https://api-docs.bigpanda.io/delete-enrichment-item-37770014e0.md
      x-source-page: Delete Enrichment Item
    patch:
      summary: Update Enrichment Item
      deprecated: false
      description: "Updates a composition or extraction enrichment item for the tag.\n\n## Authentication\nAll BigPanda APIs\
        \ require Bearer Token Authorization in the call headers.\n\nThis API uses the User API Key type of Authorization\
        \ token. Your User API Key must be provided in the header, prefixed by the word `Bearer`.\n\nExample:\n`Authorization:\
        \ Bearer [YOUR_USER_API_KEY]`\n\n> \U0001F6A7 **Config object required**\n> \n> The config object is required when\
        \ creating an enrichment item. When adding your array of enrichment items, make sure to expand the config object and\
        \ include all required parameters.\n>\n> Different fields are required for composition and extraction type enrichments.\n\
        \n## Composition enrichment items\nComposition enrichment items are created by defining a value template. The Composition\
        \ template is a simple formula to populate tag value using strings and other tag values.\n\nUse any tag value as a\
        \ variable, using the format `${<tag_name>}`. For example:\n`mywiki.com/${host}/${check}`\n\nSpecial formatting is\
        \ required for tag values that contain encoded characters for URLs. If the tag value contains encoded values for the\
        \ characters `%`, `+`, or a space, use the format `${exact(<tagname>)}` to protect the values from being re-encoded.\n\
        \nComposition configs must include the `source`, `destination`, and `value` properties.\n## Extraction enrichment\
        \ items\n\nExtraction enrichment items are created by defining a regular expression (regex formula).\n\nExtraction\
        \ Regex: The [Regular expression](https://regex101.com/) to extract the new tag value from the source tag value.\n\
        - Use a caret `^` to indicate starts with and a dollar sign `$` to indicate ends with.\n- Use parentheses to surround\
        \ the capture group for the extraction. BigPanda uses the contents of the first capture group to create the value\
        \ of the alert enrichment tag.\n- Use a [non-capturing group](https://stackoverflow.com/questions/3512471/what-is-a-non-capturing-group-in-regular-expressions)\
        \ to ignore part of the contents.\n\nIf a tag value doesn't match the pattern, the alert is not enriched with the\
        \ alert enrichment item.\n\nExtraction configs must include the `source`, `destination`, and `regex` properties.\n\
        \n**Rate limit:** 5 requests per second."
      operationId: update-tag-rule
      tags:
      - Alert Tags & Enrichment
      parameters:
      - name: alerttag_name
        in: path
        description: Tag name in BigPanda. May be a normalized tag name.
        required: true
        example: ''
        schema:
          type: string
          examples:
          - host
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                enrichments:
                  type: array
                  items:
                    allOf:
                    - $ref: '#/components/schemas/enrichment_item'
                    - type: object
                      properties:
                        id:
                          type: string
                          description: ID of the existing enrichment rule to update.
                      x-apidog-orders:
                      - id
                      required:
                      - id
                      x-apidog-ignore-properties: []
              x-apidog-orders:
              - enrichments
              x-apidog-ignore-properties: []
            examples:
              extraction:
                value:
                  enrichments:
                  - id: 2bf54f9a-2ab8-4357-b318-6f9ca722cf5e
                    type: extraction
                    active: true
                    when:
                      IN:
                      - status
                      - - critical
                    config:
                      source: host
                      selected_source_system: emailparser.ciena_mcs
                      destination: ash_service_name
                      regex: ^([^-]+)-.*$
                    note: Extract service from host
                summary: Update a rule by id
      responses:
        '200':
          x-apidog-ordering: 0
          description: '200'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/enrichment_itemresponse'
          headers: {}
          x-apidog-name: ''
        '400':
          x-apidog-ordering: 1
          description: '400'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generic400response'
          headers: {}
          x-apidog-name: ''
        '404':
          x-apidog-ordering: 2
          description: '404'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generic404response'
          headers: {}
          x-apidog-name: ''
      security:
      - BearerUser131: []
      x-publication-status: live
      x-run-in-apidog: https://app.apidog.com/web/project/1203004/apis/api-37770015-run
      x-source-url: https://api-docs.bigpanda.io/update-enrichment-item-37770015e0.md
      x-source-page: Update Enrichment Item
  /resources/v2.1/mapping-enrichment:
    post:
      summary: Create Mapping Enrichment Schema
      deprecated: false
      description: "Creates a mapping enrichment schema.\n\n## Authentication\nAll BigPanda APIs require Bearer Token Authorization\
        \ in the call headers.\n\nThis API uses the User API Key type of Authorization token. Your User API Key must be provided\
        \ in the header, prefixed by the word `Bearer`.\n\nExample:\n`Authorization: Bearer [YOUR_USER_API_KEY]`\n\n> \U0001F6A7\
        \ **override_existing**\n> \n> If ​​`override_existing`​​ is set to false, mapping values will not be added to any\
        \ alert where the field is already populated, even if the field is populated with a `null`.\n\n**Rate limit:** 5 requests\
        \ per second."
      operationId: create-mapping-enrichment-rule
      tags:
      - Alert Tags & Enrichment
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/mapping_enrichment'
      responses:
        '201':
          x-apidog-ordering: 0
          description: '201'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mapping_config_response'
          headers: {}
          x-apidog-name: ''
      security:
      - BearerUser131: []
      x-publication-status: live
      x-run-in-apidog: https://app.apidog.com/web/project/1203004/apis/api-37770024-run
      x-source-url: https://api-docs.bigpanda.io/create-mapping-enrichment-schema-37770024e0.md
      x-source-page: Create Mapping Enrichment Schema
    get:
      summary: Retrieve All Mapping Enrichment Schemas
      deprecated: false
      description: 'Lists all mapping enrichment schemas in BigPanda.


        ## Authentication

        All BigPanda APIs require Bearer Token Authorization in the call headers.


        This API uses the User API Key type of Authorization token. Your User API Key must be provided in the header, prefixed
        by the word `Bearer`.


        Example:

        `Authorization: Bearer [YOUR_USER_API_KEY]`


        **Rate limit:** 5 requests per second.'
      operationId: retrieve-all-mapping-enrichment-rule
      tags:
      - Alert Tags & Enrichment
      parameters: []
      responses:
        '200':
          x-apidog-ordering: 0
          description: '200'
          content:
            application/json:
              schema:
                type: object
                items:
                  type: object
                  properties: {}
                x-apidog-orders: []
                properties: {}
          headers: {}
          x-apidog-name: ''
      security:
      - BearerUser131: []
      x-publication-status: live
      x-run-in-apidog: https://app.apidog.com/web/project/1203004/apis/api-37770023-run
      x-source-url: https://api-docs.bigpanda.io/retrieve-all-mapping-enrichment-schemas-37770023e0.md
      x-source-page: Retrieve All Mapping Enrichment Schemas
  /resources/alert-enricher/schemas/{schema_id}/rules:
    post:
      summary: Create Mapping Enrichment Table
      deprecated: false
      description: 'Creates a new map table or replaces an existing one by uploading the complete table as a CSV file. Processing
        is asynchronous; use the returned job to track status.


        Rate limit: 5 requests per second.'
      tags:
      - Alert Tags & Enrichment
      parameters:
      - name: schema_id
        in: path
        description: ID of the advanced mapping schema.
        required: true
        example: ''
        schema:
          type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                csvdata:
                  type: string
                  format: binary
                  description: The complete mapping table as a CSV file.
                  example: ''
              required:
              - csvdata
      responses:
        '202':
          description: Upload accepted; returns a job to track

# --- truncated at 32 KB (134 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bigpanda/refs/heads/main/openapi/bigpanda-alert-enrichment-api-openapi.yml