How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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.

BigPanda Alert Tags & Enrichment API is one of 27 APIs that BigPanda publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Alerts, Enrichment, and Tags. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 45 operations across 22 paths, and defines 50 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against 2 base URLs: https://api.bigpanda.io, https://api.eu.bigpanda.io.

45 operations 22 paths 50 schemas 7 DELETE17 GET7 PATCH8 POST6 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api.bigpanda.io
Authentication
HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 2

BigPanda Alert Tags & Enrichment API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (BearerUser13). It accepts HTTP bearer tokens (BearerUser131).

  • BearerUser13 — Format: "Bearer {User API Key}" BigPanda recommends adding [Authentication](https://docs.bigpanda.io/reference/introductionauthentication-and-headers) headers…
  • BearerUser131 — Format: "Bearer {User API Key}" BigPanda recommends adding [Authentication](https://docs.bigpanda.io/reference/introductionauthentication-and-headers) headers…

Paths & Operations 45

Across 22 paths, the API surfaces 45 operations — 7 DELETE, 17 GET, 7 PATCH, 8 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

Alert Tags & Enrichment 45
GET
/resources/v2.0/alerts-enrichments-jobs/{job_id}
Check Status of Upload Job
check-status-of-upload-job 1 param → 200404
POST
/resources/alert-enricher/schemas
Create Advanced Mapping Schema
body → 201400401
GET
/resources/alert-enricher/schemas
Retrieve All Advanced Mapping Schemas
→ 200401
POST
/resources/v2.0/alert-enrichments
Create Alert Enrichment Item
create-enrichment-1 body → 200
POST
/resources/v2.1/enrichments-config/tags
Create Alert Tag
create-tag body → 201
GET
/resources/v2.1/enrichments-config/tags
Retrieve All Alert Tags
retrieve-all-tags → 200
POST
/resources/v2.1/enrichments-config/tags/{alerttag_name}/enrichments
Create Enrichment
create-tag-rule 1 param body → 200201400404
DELETE
/resources/v2.1/enrichments-config/tags/{alerttag_name}/enrichments
Delete Enrichment Item
delete-tag-rule 1 param body → 204400404
PATCH
/resources/v2.1/enrichments-config/tags/{alerttag_name}/enrichments
Update Enrichment Item
update-tag-rule 1 param body → 200400404
POST
/resources/v2.1/mapping-enrichment
Create Mapping Enrichment Schema
create-mapping-enrichment-rule body → 201
GET
/resources/v2.1/mapping-enrichment
Retrieve All Mapping Enrichment Schemas
retrieve-all-mapping-enrichment-rule → 200
POST
/resources/alert-enricher/schemas/{schema_id}/rules
Create Mapping Enrichment Table
1 param body → 202400401404
PUT
/resources/alert-enricher/schemas/{schema_id}/rules
Create or Update Map Rows
1 param body → 200400401404
DELETE
/resources/alert-enricher/schemas/{schema_id}/rules
Delete Map Rows
1 param → 204401404
GET
/resources/alert-enricher/schemas/{schema_id}/rules
Retrieve Map Rows
4 params → 200401404
POST
/resources/v2.0/alert-enrichments/{mapschema_id}/map
Create Mapping Enrichment Table Rows
create-mapping-enrichment-table-rows 1 param body → 202400
GET
/resources/v2.0/alert-enrichments/{mapschema_id}/map
Retrieve Mapping Enrichment
retrieve-mapping-enrichment-1 1 param → 200404
PATCH
/resources/v2.0/alert-enrichments/{mapschema_id}/map
Update Mapping Enrichment Table Rows
update-mapping-enrichment-table-rows-1 1 param body → 202404
POST
/resources/v2.1/mapping-enrichment/{mapschema_id}/map
Create mapping enrichment table using CSV
create-map-using-csv 2 params body → 202400
PATCH
/resources/v2.1/mapping-enrichment/{mapschema_id}/map
Create, Update, or Delete Mapping Enrichment Row
patch-map-row 1 param body → 200
GET
/resources/v2.1/mapping-enrichment/{mapschema_id}/map
Retrieve Mapping Enrichment Table
retrieve-map 3 params → 200
DELETE
/resources/alert-enricher/schemas/{schema_id}
Delete Advanced Mapping Schema
1 param → 204401404
GET
/resources/alert-enricher/schemas/{schema_id}
Retrieve Advanced Mapping Schema
1 param → 200401404
PUT
/resources/alert-enricher/schemas/{schema_id}
Update Advanced Mapping Schema
1 param body → 200400401404
DELETE
/resources/v2.0/alert-enrichments/{enrichment_id}
Delete Alert Enrichment Item
delete-enrichment-1 1 param → 202204404
GET
/resources/v2.0/alert-enrichments/{enrichment_id}
Retrieve Alert Enrichment Item
retrieve-enrichment-1 1 param → 200404
PATCH
/resources/v2.0/alert-enrichments/{enrichment_id}
Update Alert Enrichment Item
update-enrichment-1 1 param body → 200400
DELETE
/resources/v2.1/enrichments-config/tags/{alerttag_name}
Delete Alert Tag
delete-tag 1 param → 200400404
GET
/resources/v2.1/enrichments-config/tags/{alerttag_name}
Retrieve Alert Tag
retrieve-tag 1 param → 200404
PATCH
/resources/v2.1/enrichments-config/tags/{alerttag_name}
Update Alert Tag Data
update-tag-data 1 param body → 200404
DELETE
/resources/alert-enricher/schemas/{schema_id}/rules/{row_id}
Delete Mapping Enrichment Row
2 params → 204401404
PATCH
/resources/alert-enricher/schemas/{schema_id}/rules/{row_id}
Update Mapping Enrichment Row
2 params body → 200400401404
DELETE
/resources/v2.1/mapping-enrichment/{mapschema_id}
Delete Mapping Enrichment Schema
delete-mapping-enrichment-rule 1 param → 202404
GET
/resources/v2.1/mapping-enrichment/{mapschema_id}
Retrieve Mapping Enrichment Schema
retrieve-mapping-enrichment-rule 1 param → 200404
PATCH
/resources/v2.1/mapping-enrichment/{mapschema_id}
Update Mapping Enrichment Schema
update-mapping-enrichment-rule 1 param body → 200404
GET
/resources/v2.0/enrichments-config/tags
List All Alert Tags
list-all-alert-tags → 200
GET
/resources/v2.0/enrichments-config/tags/{alerttag_name}
List All Enrichment Items of a Tag
list-all-enrichments-2 1 param → 200204404
GET
/resources/v2.1/alert-enrichments-jobs/{job_id}
Retrieve Mapping Table Job Status
retrieve-job-status 1 param → 200
GET
/resources/alert-enricher/jobs/{job_id}
Retrieve Upload Job Status
1 param → 200401404
GET
/resources/v2.0/enrichments-config/tags/{alerttag_name}/order
Retrieve enrichment item order
retrieve-tags-order_2 1 param → 200204
PUT
/resources/v2.0/enrichments-config/tags/{alerttag_name}/order
Update Enrichment Items Order
update-enrichment-items-order-of-a-tag 1 param body → 200400
GET
/resources/v2.0/enrichments-config
Retrieve tags order
retrieve-tags-order → 200204
PUT
/resources/v2.0/enrichments-config
Update tag order
update-tags-order 1 param → 200400
PUT
/resources/v2.1/enrichments-config
Update Alert Tag Order
update-tag-order body → 200
PUT
/resources/v2.1/enrichments-config/tags/{alerttag_name}/order
Update Enrichment Item Order for an Alert Tag
update-rule-order-for-a-tag 1 param body → 200400

Schemas 50

The contract defines 50 schemas that model the data the API accepts and returns. The most detailed are mapping_enrichment_response (9 properties), enrichment_itemresponse (9 properties), alert_tag_response2 (8 properties), alert_tag_response (8 properties). Each schema is shown below with its type and property counts.

enrichment_item
object
Schema for an enrichment item.
5 properties
enrichment_config_mapping
object
Schema for a mapping enrichment rule.
2 properties
enrichment_field
object
Definition for an individual enrichment field.
6 properties
enrichment_config_extraction
object
Configuration for an extraction enrichment item.
5 properties 3 required
enrichment_config_composition
object
Configuration for a composition enrichment item.
3 properties 3 required
when
object
A [​BPQL object query](https://api-docs.bigpanda.io/endescription/bpql-object-syntax)​​ to filter incoming alerts. Only matched alerts will receive a value bas…
generic404response
object
Requested endpoint or resource is not found.
2 properties
advanced_mapping_schema
object
An advanced mapping enrichment schema. Advanced mapping creates dynamic map rules that account for variable inbound fields across monitoring tools, with option…
5 properties 3 required
advanced_mapping_config
object
Advanced mapping configuration: the ordered set of map columns.
1 property 1 required
advanced_mapping_field
object
A column definition in an advanced mapping schema.
3 properties 2 required
advanced_mapping_group
object
A rule that clusters result columns together.
4 properties 4 required
advanced_mapping_group_field
object
A grouped column reference.
2 properties 2 required
error-response-v1
object
BP default error response
2 properties 2 required
http-status-code-v1
number
Standard HTTP Status Code as explained in https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
alert_tag_object
object
Schema representing a BigPanda alert tag with optional enrichments.
4 properties 2 required
active
boolean
Whether the new configuration should apply to future data.
description
string
alert_tag_response
object
Schema representing a BigPanda alert tag with optional enrichments.
8 properties
updated_at
integer
The time the resource was last updated(in Unix epoch seconds).
updated_by
string
System id of the user or tool that last updated the resource.
created_at
integer
The time the resource was created(in Unix epoch seconds).
created_by
string
System id of the user or tool that created the resource.
enrichment_itemresponse
object
Schema for an enrichment item, including composition and extraction types.
9 properties
generic400response
object
Call is missing parameters or malformed.
2 properties
mapping_enrichment
object
Definition for a mapping enrichment schema.
5 properties
mapping_config
object
Rules for mapping tag values to event data.
4 properties
mapping_config_response
object
Rules for mapping tag values to event data.
5 properties
note
string
An optional comment or short description.
job_status
object
Status of a background job.
3 properties
job_id
string
System id of the asynchronous job.
map_row_change
object
The details of the map change.
2 properties 2 required
mapping_enrichment_response
object
Definition for a mapping enrichment schema.
9 properties
advanced_mapping_row
object
A map row. Must include an id (UUID); the remaining keys are the map columns and must follow the schema's config. To insert a new row, generate a new UUID.
1 property 1 required
generic202response
object
Call was successful.
2 properties
generic204response
object
Call was successful.
2 properties
alert_tag_response2
object
Schema representing a BigPanda alert tag with optional enrichments.
8 properties
enrichment_item2
object
Schema for an enrichment item.
5 properties
enrichment_config_mapping2
object
Schema for a mapping enrichment rule.
2 properties
enrichment_field2
object
Definition for an individual enrichment field.
6 properties
enrichment_config_extraction2
object
Configuration for an extraction enrichment item.
5 properties 3 required
enrichment_config_composition2
object
Configuration for a composition enrichment item.
3 properties 3 required
when2
object
A [​BPQL object query](https://api-docs.bigpanda.io/endescription/bpql-object-syntax)​​ to filter incoming alerts. Only matched alerts will receive a value bas…
generic400response2
object
Call is missing parameters or malformed.
2 properties
generic404response2
object
Requested endpoint or resource is not found.
2 properties
map_object_return
object
Enrichment map in json key value pairs.
2 properties
mapping_config_response2
object
Rules for mapping tag values to event data.
5 properties
enrichment_order
array
List of enrichment IDs in the order they should run. By default, items are ordered by creation time.
alert_tags_order
array
List of tag names in the order they should be run.
enrichment_order_response
object
Schema for specifying the order of enrichment items.
2 properties
update_mapping_enrichment
object
Definition for a updating a mapping enrichment schema. After a schema has been created, only the schema status, condition, and description can be edited. To ch…
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bigpanda-alert-enrichment-api-openapi.yml Raw ↑

Other APIs BigPanda publishes across the network.

BigPanda Agents API (MCP & A2A)
BigPanda AI Settings API
BigPanda Alert Filters API
BigPanda Alert Ingestion (OIM) API
BigPanda Alerts API
BigPanda API Keys API
BigPanda Audit API
BigPanda Biggy Query API
BigPanda Change Risk API
BigPanda Changes & Root Cause API
BigPanda Correlation Patterns API
BigPanda Data Connectors API
Where this information came from

This is an independent, third-party profile of BigPanda Alert Tags & Enrichment API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.