Versioned email-parser integration configuration, mirroring the OIM configuration lifecycle.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/bigpanda-email-parser-configuration-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
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: 3.0.3
info:
title: BigPanda Email Parser Configuration API
description: BigPanda Email Parser Configuration 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: 6
servers:
- url: https://api.bigpanda.io
description: US Region
- url: https://api.eu.bigpanda.io
description: EU Region
tags:
- name: Email Parser Configuration
paths:
/configurations/alerts/{integration}/{app_key_p}/versions/diff:
get:
summary: Compare Configuration Versions for Email Parser
deprecated: false
description: 'Return a diff between two saved versions of the integration configuration. The response highlights the
fields that have been added, removed, or modified between the `from` and `to` versions.
> 📘 **Version History Availability**
>
> Configuration version history begins at May 5 2026. Records of configurations saved prior to history start cannot
be retrieved.
## Authentication
All BigPanda APIs require Bearer Token Authorization in the call headers.
This API uses the Organization token type of Authorization token. Your org token must be provided in the header, prefixed
by the word `Bearer`.
Example:
`Authorization: Bearer [YOUR_ORG_TOKEN]`
'
operationId: diff-configuration-versions
tags:
- Email Parser Configuration
parameters:
- name: integration
in: path
description: The integration type. Use `oim` for Open Integration Manager v2 or `emailparser` for the Email Parser.
required: true
example: ''
schema:
type: string
enum:
- oim
- emailparser
examples:
- oim
- name: app_key
in: path
description: The app key for the associated integration.
required: true
example: ''
schema:
type: string
examples:
- gag342351qgb
- name: app_key_p
in: path
description: ''
required: true
example: ''
schema:
type: string
- name: from
in: query
description: The base version identifier to compare from. Minimum 1.
required: true
schema:
type: integer
examples:
- 1
- name: to
in: query
description: The target version identifier to compare to. Minimum 1.
required: true
schema:
type: integer
examples:
- 2
responses:
'200':
x-apidog-ordering: 0
description: Success
content:
application/json:
schema:
type: object
properties:
from:
type: string
description: The base version identifier provided in the request.
to:
type: string
description: The target version identifier provided in the request.
diff:
type: array
description: List of field-level differences between the two versions.
items:
type: object
properties:
key:
type: string
description: JSON path of the field that changed.
old_value:
type: string
new_value:
type: string
x-apidog-orders:
- key
- old_value
- new_value
x-apidog-ignore-properties: []
x-apidog-orders:
- from
- to
- diff
x-apidog-ignore-properties: []
headers: {}
x-apidog-name: ''
'400':
x-apidog-ordering: 1
description: '400'
content:
application/json:
schema:
$ref: '#/components/schemas/generic400response'
headers: {}
x-apidog-name: ''
'401':
description: Unauthorized
headers: {}
x-apidog-name: ''
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/error-response-v1'
headers: {}
x-apidog-name: ''
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/error-response-v1'
headers: {}
x-apidog-name: ''
security:
- BearerOrg5: []
x-publication-status: internal
x-run-in-apidog: https://app.apidog.com/web/project/1203004/apis/api-41913640-run
x-source-url: https://api-docs.bigpanda.io/compare-configuration-versions-for-email-parser-41913640e0.md
x-source-page: Compare Configuration Versions for Email Parser
/configurations/alerts/emailparser/{app_key_p}:
post:
summary: Create/Update Email Parser Configuration
deprecated: false
description: "## Authentication\nAll BigPanda APIs require Bearer Token Authorization in the call headers.\nThis API\
\ uses the Organization token type of Authorization token. Your org token must be provided in the header, prefixed\
\ by the word `Bearer`.\n\nExample:\n`Authorization: Bearer [YOUR_ORG_TOKEN]`\n\n> \U0001F6A7 **Incorrect URL in Builder**\n\
> \n> This endpoint is accessed at the https://integrations.bigpanda.io url, not https://api.bigpanda.io\n\n## Pre-configuration\n\
Before an email integration can be configured using the Email Parser API, the integration must be created within the\
\ UI.\nFollow the in-product steps to create a new Alerts API Integration and make note of the app key and integration\
\ id.\nOnce created, the integration can be configured through the Email Parser API\n"
operationId: create-update-email-parser-configuration
tags:
- Email Parser Configuration
parameters:
- name: app_key_p
in: path
description: The app key for the associated integration.
required: true
example: ''
schema:
type: string
examples:
- gag342351qgb
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/email_parser_config'
responses:
'200':
x-apidog-ordering: 0
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/email_parser_config'
headers: {}
x-apidog-name: ''
security:
- BearerOrg22: []
x-publication-status: live
x-run-in-apidog: https://app.apidog.com/web/project/1203004/apis/api-37770212-run
x-source-url: https://api-docs.bigpanda.io/createupdate-email-parser-configuration-37770212e0.md
x-source-page: Create/Update Email Parser Configuration
get:
summary: Retrieve Email Parser Configuration
deprecated: false
description: "Get a specific parser configuration.\n\n## Authentication\nAll BigPanda APIs require Bearer Token Authorization\
\ in the call headers.\nThis API uses the Organization token type of Authorization token. Your org token must be provided\
\ in the header, prefixed by the word `Bearer`.\n\nExample:\n`Authorization: Bearer [YOUR_ORG_TOKEN]`\n\n> \U0001F6A7\
\ **Incorrect URL in Builder**\n> \n> This endpoint is accessed at the https://integrations.bigpanda.io url, not https://api.bigpanda.io\n"
operationId: retrieve-email-parser-configuration
tags:
- Email Parser Configuration
parameters:
- name: app_key_p
in: path
description: The app key for the associated integration.
required: true
example: ''
schema:
type: string
examples:
- gag342351qgb
responses:
'200':
x-apidog-ordering: 0
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/email_parser_config'
headers: {}
x-apidog-name: ''
security:
- BearerOrg22: []
x-publication-status: live
x-run-in-apidog: https://app.apidog.com/web/project/1203004/apis/api-37770211-run
x-source-url: https://api-docs.bigpanda.io/retrieve-email-parser-configuration-37770211e0.md
x-source-page: Retrieve Email Parser Configuration
/configurations/alerts/{integration}/{app_key_p}/versions:
get:
summary: List Configuration Versions for Email Parser
deprecated: false
description: 'Retrieve the list of saved configuration versions for the specified integration. Each entry represents
a previously saved configuration, ordered from oldest to most recent.
> 📘 **Version History Availability**
>
> Configuration version history begins at May 5 2026. Records of configurations saved prior to history start cannot
be retrieved.
## Authentication
All BigPanda APIs require Bearer Token Authorization in the call headers.
This API uses the Organization token type of Authorization token. Your org token must be provided in the header, prefixed
by the word `Bearer`.
Example:
`Authorization: Bearer [YOUR_ORG_TOKEN]`
'
operationId: list-configuration-versions
tags:
- Email Parser Configuration
parameters:
- name: integration
in: path
description: The integration type. Use `oim` for Open Integration Manager v2 or `emailparser` for the Email Parser.
required: true
example: ''
schema:
type: string
enum:
- oim
- emailparser
examples:
- oim
- name: app_key
in: path
description: The app key for the associated integration.
required: true
example: ''
schema:
type: string
examples:
- gag342351qgb
- name: app_key_p
in: path
description: ''
required: true
example: ''
schema:
type: string
responses:
'200':
x-apidog-ordering: 0
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/versions'
headers: {}
x-apidog-name: ''
'400':
x-apidog-ordering: 1
description: '400'
content:
application/json:
schema:
$ref: '#/components/schemas/generic400response'
headers: {}
x-apidog-name: ''
'401':
description: Unauthorized
headers: {}
x-apidog-name: ''
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/error-response-v1'
headers: {}
x-apidog-name: ''
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/error-response-v1'
headers: {}
x-apidog-name: ''
security:
- BearerOrg5: []
x-publication-status: internal
x-run-in-apidog: https://app.apidog.com/web/project/1203004/apis/api-41913643-run
x-source-url: https://api-docs.bigpanda.io/list-configuration-versions-for-email-parser-41913643e0.md
x-source-page: List Configuration Versions for Email Parser
/configurations/alerts/{integration}/{app_key_p}/versions/{version}/restore:
post:
summary: Restore Configuration Version Email Parser
deprecated: false
description: 'Restore the integration configuration to a previously saved version. The restored configuration becomes
the active configuration and a new version entry is created in the history.
> 📘 **Version History Availability**
>
> Configuration version history begins at May 5 2026. Records of configurations saved prior to history start cannot
be retrieved.
## Authentication
All BigPanda APIs require Bearer Token Authorization in the call headers.
This API uses the Organization token type of Authorization token. Your org token must be provided in the header, prefixed
by the word `Bearer`.
Example:
`Authorization: Bearer [YOUR_ORG_TOKEN]`
'
operationId: restore-configuration-version
tags:
- Email Parser Configuration
parameters:
- name: integration
in: path
description: The integration type. Use `oim` for Open Integration Manager v2 or `emailparser` for the Email Parser.
required: true
example: ''
schema:
type: string
enum:
- oim
- emailparser
examples:
- oim
- name: app_key
in: path
description: The app key for the associated integration.
required: true
example: ''
schema:
type: string
examples:
- gag342351qgb
- name: version
in: path
description: The identifier of the configuration version to restore. Minimum 1.
required: true
example: 0
schema:
type: integer
examples:
- 1
- name: app_key_p
in: path
description: ''
required: true
example: ''
schema:
type: string
responses:
'200':
x-apidog-ordering: 0
description: Success
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/oim_v2_config'
- $ref: '#/components/schemas/email_parser_config'
headers: {}
x-apidog-name: ''
'400':
x-apidog-ordering: 1
description: '400'
content:
application/json:
schema:
$ref: '#/components/schemas/generic400response'
headers: {}
x-apidog-name: ''
'401':
description: Unauthorized
headers: {}
x-apidog-name: ''
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/error-response-v1'
headers: {}
x-apidog-name: ''
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/error-response-v1'
headers: {}
x-apidog-name: ''
security:
- BearerOrg5: []
x-publication-status: internal
x-run-in-apidog: https://app.apidog.com/web/project/1203004/apis/api-41913641-run
x-source-url: https://api-docs.bigpanda.io/restore-configuration-version-email-parser-41913641e0.md
x-source-page: Restore Configuration Version Email Parser
/configurations/alerts/{integration}/{app_key_p}/versions/{version}:
get:
summary: Retrieve Configuration Version for Email Parser
deprecated: false
description: 'Retrieve a specific saved version of the integration configuration.
> 📘 **Version History Availability**
>
> Configuration version history begins at May 5 2026. Records of configurations saved prior to history start cannot
be retrieved.
## Authentication
All BigPanda APIs require Bearer Token Authorization in the call headers.
This API uses the Organization token type of Authorization token. Your org token must be provided in the header, prefixed
by the word `Bearer`.
Example:
`Authorization: Bearer [YOUR_ORG_TOKEN]`
'
operationId: retrieve-configuration-version
tags:
- Email Parser Configuration
parameters:
- name: integration
in: path
description: The integration type. Use `oim` for Open Integration Manager v2 or `emailparser` for the Email Parser.
required: true
example: ''
schema:
type: string
enum:
- oim
- emailparser
examples:
- oim
- name: app_key
in: path
description: The app key for the associated integration.
required: true
example: ''
schema:
type: string
examples:
- gag342351qgb
- name: version
in: path
description: The identifier of the configuration version to retrieve. Minimum 1.
required: true
example: 0
schema:
type: integer
examples:
- 1
- name: app_key_p
in: path
description: ''
required: true
example: ''
schema:
type: string
responses:
'200':
x-apidog-ordering: 0
description: Success
content:
application/json:
schema:
type: object
properties:
org:
type: string
resource_type:
type: string
resource_id:
type: string
version:
type: integer
payload:
type: object
properties:
oneOf:
type: string
x-apidog-orders:
- oneOf
x-apidog-ignore-properties: []
saved_at:
type: string
x-apidog-orders:
- org
- resource_type
- resource_id
- version
- payload
- saved_at
x-apidog-ignore-properties: []
headers: {}
x-apidog-name: ''
'400':
x-apidog-ordering: 1
description: '400'
content:
application/json:
schema:
$ref: '#/components/schemas/generic400response'
headers: {}
x-apidog-name: ''
'401':
description: Unauthorized
headers: {}
x-apidog-name: ''
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/error-response-v1'
headers: {}
x-apidog-name: ''
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/error-response-v1'
headers: {}
x-apidog-name: ''
security:
- BearerOrg5: []
x-publication-status: internal
x-run-in-apidog: https://app.apidog.com/web/project/1203004/apis/api-41913642-run
x-source-url: https://api-docs.bigpanda.io/retrieve-configuration-version-for-email-parser-41913642e0.md
x-source-page: Retrieve Configuration Version for Email Parser
components:
securitySchemes:
BearerOrg22:
type: http
scheme: bearer
description: 'Format: "Bearer {Org Token}" BigPanda recommends adding
[Authentication](https://docs.bigpanda.io/reference/introduction#authentication-and-headers) headers only in the secure
tool you use to make API calls
'
BearerOrg5:
type: apiKey
description: 'Format: "Bearer {Org Token}" BigPanda recommends adding [Authentication](https://docs.bigpanda.io/reference/introduction#authentication-and-headers)
headers only in the secure tool you use to make API calls'
name: Authorization
in: header
schemas:
error-response-v1:
title: error-response-v1
type: object
description: BP default error response
properties:
status:
$ref: '#/components/schemas/http-status-code-v1'
errors:
type: array
items:
type: string
required:
- status
- errors
x-apidog-orders:
- status
- errors
x-apidog-ignore-properties: []
x-apidog-folder: ''
http-status-code-v1:
type: number
enum:
- 100
- 101
- 102
- 103
- 200
- 201
- 202
- 203
- 204
- 205
- 206
- 207
- 300
- 301
- 302
- 303
- 304
- 305
- 307
- 308
- 400
- 401
- 402
- 403
- 404
- 405
- 406
- 407
- 408
- 409
- 410
- 411
- 412
- 413
- 414
- 415
- 416
- 417
- 418
- 421
- 422
- 423
- 424
- 426
- 428
- 429
- 431
- 451
- 500
- 501
- 502
- 503
- 504
- 505
- 507
- 511
description: Standard HTTP Status Code as explained in https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
x-apidog-folder: ''
generic400response:
type: object
description: 'Call is missing parameters or malformed.
'
properties:
status:
type: integer
examples:
- 400
errors:
type: array
items:
type: string
examples:
- Call is missing parameters or malformed.
x-apidog-orders:
- status
- errors
x-apidog-ignore-properties: []
x-apidog-folder: ''
email_parser_config:
type: object
description: Configuration object schema for the email parser integration.
properties:
config:
type: object
description: Parsing rules for the email copy.
properties:
email_format:
type: string
description: Format of the email content. Options are `plain_text` or `html`.
examples:
- plain_text
allow_list:
type: array
items:
type: string
description: An array of allowed sender emails. Use a wildcard to allow for a range of email addresses. If no
address is provided, the parser will accept emails from any source and may lead to false alarms or issues.
examples:
- - '*@example.com'
status:
$ref: '#/components/schemas/status_mapping'
primary_property:
type: object
description: Mapping rule for the primary property.
properties:
name:
type: string
examples:
- host
description: Title of property. Default is `alert_title`
source:
type: string
examples:
- body
description: Is the value in the body or subject? Default is `subject`
extraction:
type: string
examples:
- host is (.*)
description: Regex rule to extract value
default_to:
type: string
examples:
- general issue
description: Value if nothing is extracted
x-apidog-orders:
- name
- source
- extraction
- default_to
x-apidog-ignore-properties: []
secondary_property:
type: object
description: Mapping rule for the secondary property.
properties:
name:
type: string
examples:
- region
description: Title of property
source:
type: string
examples:
- body
description: Is the value in the body or subject?
extraction:
type: string
examples:
- region (.*)
description: Regex rule to extract value
default_to:
type: string
examples:
- us-west-1
description: Value if nothing is extracted
x-apidog-orders:
- name
- source
- extraction
- default_to
x-apidog-ignore-properties: []
additional_attributes:
type: array
items:
type: object
properties:
name:
type: string
examples:
- region
description: Title of property
source:
type: string
examples:
- body
description: Is the value in the body or subject?
extraction:
type: string
examples:
- 'region: (.*)'
description: Regex rule to extract value
default_to:
type: string
examples:
- us-west-2
description: Value if nothing is extracted
x-apidog-orders:
- name
- source
- extraction
- default_to
x-apidog-ignore-properties: []
description: Array of payload field objects to set mapping rules for additional tags. Each object must be defined.
x-apidog-orders:
- email_format
- allow_list
- status
- primary_property
- secondary_property
- additional_attributes
x-apidog-ignore-properties: []
sample_payload:
$ref: '#/components/schemas/sample_payload'
x-apidog-orders:
- config
- sample_payload
x-apidog-ignore-properties: []
x-apidog-folder: ''
sample_payload:
type: object
description: An example event payload from the tool that includes all tags that need to be normalized or referred to
in the schema.
x-apidog-orders: []
properties: {}
x-apidog-folder: ''
examples:
- "{ \"sample_payload\": {\n \"alerts\": [\n {\n \"generatorURL\": \"https://some-url.io\",\n \
\ \"fingerprint\": \"123456789\",\n \"annotations\": {\n \"description\": \"This alert is used to\
\ check the CPU utilization of this non-existent server\",\n \"runbook_url\": \"https://runbook.io/cpu-check\"\
\n },\n \"startsAt\": \"2022-07-05T19:59:25.661Z\",\n \"endsAt\": \"0001-01-01T00:00:00Z\",\n\
\ \"status\": \"firing\",\n \"labels\": {\n \"severity\": \"page\",\n \"instance\"\
: \"bigpanda-server\",\n \"alertname\": \"BigPanda Test\",\n \"team\": \"metrics\",\n \"\
env\": \"test\",\n \"job\": \"CPU Check\",\n \"locale\": \"ca\",\n \"timestamp\": \"1.657051103137505e+09\"\
\n }\n }\n ],\n \"commonLabels\": {\n \"instance\": \"bigpanda-server\",\n \"alertname\"\
: \"BigPanda Test\",\n \"team\": \"metrics\",\n \"env\": \"test\",\n \"job\": \"CPU Check\",\n \
\ \"locale\": \"ca\",\n \"timestamp\": \"1.657051103137505e+09\"\n },\n \"externalURL\": \"https://external-url.io\"\
,\n \"groupLabels\": {\n \"instance\": \"bigpanda-server\",\n \"alertname\": \"BigPanda Test\",\n \
\ \"team\": \"metrics\",\n \"env\": \"test\",\n \"job\": \"CPU Check\",\n \"locale\": \"ca\",\n \
\ \"timestamp\": \"1.657051103137505e+09\"\n },\n \"receiver\": \"bigpanda\",\n \"version\": \"4\",\n\
\ \"commonAnnotations\": {\n \"description\": \"This alert is used to check the CPU utilization of this non-existent\
\ server\",\n \"runbook_url\": \"https://runbook.io/cpu-check\"\n },\n \"status\": \"firing\"\n }\n"
x-apidog-ignore-properties: []
status_mapping:
type: object
properties:
default_to:
type: string
examples:
- critical
description: The value to populate if no matches are found. `Critical` is default setting.
source:
type: array
items:
type: string
examples:
- - '@alert.status'
- '@alert.labels.severity'
description: Is the value in the body or subject?
status_map:
type: object
additionalProperties:
type: array
items:
type: string
x-apidog-orders: []
examples:
- critical:
- page
- critical
warning:
- warn
- warning
acknowledged:
- acknowledged
ok:
- resolved
description: Defines values that map to assigned statuses. Values will be matched in order, stopping at the first
match. One of [`critical`, `warning`, `ok`, `acknowledged`]
properties: {}
x-apidog-ignore-properties: []
x-apidog-orders:
- default_to
- source
- status_map
description: null
x-apidog-ignore-properties: []
x-apidog-folder: ''
versions:
type: array
description: List of version changes
items:
type: object
properties:
version:
type: string
description: The unique identifier of the saved configuration version.
examples:
- '2026-04-29T15:42:11Z'
saved_at:
type: string
format: date-time
description: The timestamp when the version was saved.
x-apidog-orders:
- version
- saved_at
x-apidog-ignore-properties: []
x-apidog-folder: ''
oim_v2_config:
type: object
properties:
config:
type: object
description: The schema for the integration configuration.
properties:
additional_attributes:
type: array
description: Array of payload mapping rules for additional tags.
items:
$ref: '#/components/schemas/additional_attributes'
array_source:
type: string
description: Defines which payload property contains the tag values if is_array=true.
examples:
- alerts
is_array:
type: boolean
description: Whether the payloads sent
# --- truncated at 32 KB (38 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bigpanda/refs/heads/main/openapi/bigpanda-email-parser-configuration-api-openapi.yml