post https://integrations.bigpanda.io/configurations/alerts/oim/
Open Integration Manager v2 Configuration
The Open Integration Manager v2 API Configuration should only be used by customers who onboarded the BigPanda platform in 2023 and after.
In the future, we plan to make this available to other customers that were onboarded prior to 2023. An upgrade will not be required and both configuration versions will continue to be supported.
Authentication
All BigPanda APIs require Bearer Token Authorization in the call headers.
This API uses the Org Token type of Authorization token.
Sample Payload
For field validation, BigPanda checks against an existing sample JSON payload from the integration. For all create calls to the API, a sample must be included in the body of all calls. For update calls to the API, the sample payload field must be included, but can be blank.
All payload fields referenced in configuration settings must be included in the sample.
Sample Call
curl --request POST \
--url https://integrations.bigpanda.io/configurations/alerts/oim/{appkey} \
--header 'Authorization: Bearer {YOUR ORG TOKEN}' \
--header 'Content-Type: application/json' \
--data '
{
"config": {
"additional_attributes": [
{
"isDestinationAccepted": true,
"isSourceAccepted": true,
"isSuggestion": true,
"name": "check",
"source": [
"@alert.labels.alertname",
"@alert.labels.check",
"@alert.labels.alert",
"@alert.labels.sdesc",
"@alert.labels.short_desc",
"@alert.labels.title"
],
"suggestedDestination": "check",
"suggestedSources": [
"@alert.labels.alertname",
"@alert.labels.check",
"@alert.labels.alert",
"@alert.labels.sdesc",
"@alert.labels.short_desc",
"@alert.labels.title"
]
},
{
"isDestinationAccepted": true,
"isSourceAccepted": true,
"isSuggestion": true,
"name": "application",
"source": [
"@alert.labels.app_name",
"@alert.labels.application",
"@alert.labels.app",
"@alert.labels.impacted_app"
],
"suggestedDestination": "application",
"suggestedSources": [
"@alert.labels.app_name",
"@alert.labels.application",
"@alert.labels.app",
"@alert.labels.impacted_app"
]
},
{
"isDestinationAccepted": true,
"isSourceAccepted": true,
"isSuggestion": true,
"name": "assignment_group",
"source": [
"@alert.labels.assignment_group",
"@alert.labels.support_group",
"@alert.labels.routing_group",
"@alert.labels.escalation_group",
"@alert.labels.workgroup"
],
"suggestedDestination": "assignment_group",
"suggestedSources": [
"@alert.labels.assignment_group",
"@alert.labels.support_group",
"@alert.labels.routing_group",
"@alert.labels.escalation_group",
"@alert.labels.workgroup"
]
},
{
"isDestinationAccepted": true,
"isSourceAccepted": true,
"isSuggestion": true,
"name": "description",
"source": [
"@alert.labels.summary",
"@alert.labels.ldesc",
"@alert.labels.long_desc",
"@alert.labels.problem"
],
"suggestedDestination": "description",
"suggestedSources": [
"@alert.labels.summary",
"@alert.labels.ldesc",
"@alert.labels.long_desc",
"@alert.labels.problem"
]
},
{
"isDestinationAccepted": true,
"isSourceAccepted": true,
"isSuggestion": true,
"name": "host",
"source": [
"@alert.labels.host",
"@alert.labels.hostname",
"@alert.labels.instance",
"@alert.labels.device",
"@alert.labels.machine",
"@alert.labels.server",
"@alert.labels.hosts",
"@alert.labels.node"
],
"suggestedDestination": "host",
"suggestedSources": [
"@alert.labels.host",
"@alert.labels.hostname",
"@alert.labels.instance",
"@alert.labels.device",
"@alert.labels.machine",
"@alert.labels.server",
"@alert.labels.hosts",
"@alert.labels.node"
]
},
{
"isDestinationAccepted": true,
"isSourceAccepted": true,
"isSuggestion": true,
"name": "location",
"source": [
"@alert.labels.location",
"@alert.labels.physical_location",
"@alert.labels.device_location"
],
"suggestedDestination": "location",
"suggestedSources": [
"@alert.labels.location",
"@alert.labels.physical_location",
"@alert.labels.device_location"
]
},
{
"isDestinationAccepted": true,
"isSourceAccepted": true,
"isSuggestion": true,
"name": "priority",
"source": [
"@alert.labels.priority",
"@alert.labels.severity",
"@alert.labels.inc_priority"
],
"suggestedDestination": "priority",
"suggestedSources": [
"@alert.labels.priority",
"@alert.labels.severity",
"@alert.labels.inc_priority"
]
},
{
"isDestinationAccepted": true,
"isSourceAccepted": true,
"isSuggestion": true,
"name": "service",
"source": [
"@alert.labels.service",
"@alert.labels.impact_service",
"@alert.labels.srvc"
],
"suggestedDestination": "service",
"suggestedSources": [
"@alert.labels.service",
"@alert.labels.impact_service",
"@alert.labels.srvc"
]
},
{
"isDestinationAccepted": true,
"isSourceAccepted": true,
"isSuggestion": true,
"name": "cmdb_ci",
"source": [
"@alert.labels.impacted_ci",
"@alert.labels.configuration_item",
"@alert.labels.ci_name"
],
"suggestedDestination": "cmdb_ci",
"suggestedSources": [
"@alert.labels.impacted_ci",
"@alert.labels.configuration_item",
"@alert.labels.ci_name"
]
},
{
"isDestinationAccepted": true,
"isSourceAccepted": true,
"isSuggestion": true,
"name": "business_group",
"source": [
"@alert.labels.business_unit",
"@alert.labels.logical_group",
"@alert.labels.lob"
],
"suggestedDestination": "business_group",
"suggestedSources": [
"@alert.labels.business_unit",
"@alert.labels.logical_group",
"@alert.labels.lob"
]
},
{
"isDestinationAccepted": true,
"isSourceAccepted": true,
"isSuggestion": true,
"name": "impact",
"source": [
"@alert.labels.inc_impact"
],
"suggestedDestination": "impact",
"suggestedSources": [
"@alert.labels.inc_impact"
]
},
{
"isDestinationAccepted": true,
"isSourceAccepted": true,
"isSuggestion": true,
"name": "urgency",
"source": [
"@alert.labels.inc_urgency"
],
"suggestedDestination": "urgency",
"suggestedSources": [
"@alert.labels.inc_urgency"
]
},
{
"isDestinationAccepted": true,
"isSourceAccepted": true,
"isSuggestion": true,
"name": "environment",
"source": [
"@alert.labels.env",
"@alert.labels.tier",
"@alert.labels.stage"
],
"suggestedDestination": "environment",
"suggestedSources": [
"@alert.labels.env",
"@alert.labels.tier",
"@alert.labels.stage"
]
},
{
"isDestinationAccepted": true,
"isSourceAccepted": true,
"isSuggestion": true,
"name": "network_device",
"source": [
"@alert.labels.router",
"@alert.labels.routers",
"@alert.labels.switch",
"@alert.labels.switches",
"@alert.labels.hub",
"@alert.labels.repeater",
"@alert.labels.bridge",
"@alert.labels.gateway "
],
"suggestedDestination": "network_device",
"suggestedSources": [
"@alert.labels.router",
"@alert.labels.routers",
"@alert.labels.switch",
"@alert.labels.switches",
"@alert.labels.hub",
"@alert.labels.repeater",
"@alert.labels.bridge",
"@alert.labels.gateway "
]
},
{
"isDestinationAccepted": true,
"isSourceAccepted": true,
"isSuggestion": true,
"name": "cluster",
"source": [
"@alert.labels.rack",
"@alert.labels.tower"
],
"suggestedDestination": "cluster",
"suggestedSources": [
"@alert.labels.rack",
"@alert.labels.tower"
]
},
{
"isDestinationAccepted": true,
"isSourceAccepted": true,
"isSuggestion": true,
"name": "runbook_url",
"source": [
"@alert.labels.runbook_link",
"@alert.labels.knowledge_base",
"@alert.labels.ki_article",
"@alert.labels.support_link",
"@alert.labels.kb_article",
"@alert.labels.wiki_url"
],
"suggestedDestination": "runbook_url",
"suggestedSources": [
"@alert.labels.runbook_link",
"@alert.labels.knowledge_base",
"@alert.labels.ki_article",
"@alert.labels.support_link",
"@alert.labels.kb_article",
"@alert.labels.wiki_url"
]
},
{
"isSuggestion": false,
"source": [
"@alert.startsat"
]
},
{
"isSuggestion": false,
"source": [
"@alert.endsat"
]
},
{
"isSuggestion": false,
"source": [
"@alert.generatorurl"
]
},
{
"flatten": true,
"isSuggestion": false,
"source": [
"@alert.annotations"
]
},
{
"flatten": true,
"isSuggestion": false,
"source": [
"@alert.labels"
]
},
{
"isSuggestion": false,
"source": [
"@alert.labels.instance",
"@alert.labels.job",
"@alert.labels.alertname"
]
},
{
"isSuggestion": false,
"source": [
"@alert.labels.monitor",
"@alert.labels.alertname"
]
}
],
"array_source": "alerts",
"is_array": true,
"map_remaining": false,
"primary_property": [
{
"name": "host"
},
{
"name": "application"
},
{
"name": "service"
}
],
"secondary_property": [
{
"name": "check"
},
{
"name": "description"
}
],
"status": {
"default_to": "critical",
"source": [
"@alert.status",
"@alert.labels.severity"
],
"status_map": {
"acknowledged": [
"acknowledged"
],
"critical": [
"page",
"critical"
],
"ok": [
"resolved"
],
"warning": [
"warn",
"warning"
]
}
},
"timestamp": {
"source": [
"@alert.annotations.timestamp",
"@alert.startsat",
"@alert.endsat"
]
},
"version": "2.0"
},
"sample_payload": {
"alerts": [
{
"annotations": {
"description": "This alert is used to check the CPU utilization of this non-existent server",
"runbook_url": "https://runbook.io/cpu-check"
},
"endsAt": "0001-01-01T00:00:00Z",
"fingerprint": "123456789",
"generatorURL": "https://some-url.io",
"labels": {
"alertname": "BigPanda Test",
"env": "test",
"instance": "bigpanda-server",
"job": "CPU Check",
"locale": "ca",
"severity": "page",
"team": "metrics",
"timestamp": "1.657051103137505e+09"
},
"startsAt": "2022-07-05T19:59:25.661Z",
"status": "firing"
}
],
"commonAnnotations": {
"description": "This alert is used to check the CPU utilization of this non-existent server",
"runbook_url": "https://runbook.io/cpu-check"
},
"commonLabels": {
"alertname": "BigPanda Test",
"env": "test",
"instance": "bigpanda-server",
"job": "CPU Check",
"locale": "ca",
"team": "metrics",
"timestamp": "1.657051103137505e+09"
},
"externalURL": "https://external-url.io",
"groupLabels": {
"alertname": "BigPanda Test",
"env": "test",
"instance": "bigpanda-server",
"job": "CPU Check",
"locale": "ca",
"team": "metrics",
"timestamp": "1.657051103137505e+09"
},
"receiver": "bigpanda",
"status": "firing",
"version": "4"
}
}
curl --request POST \
--url https://eu.integrations.bigpanda.io/configurations/alerts/oim/{appkey} \
--header 'Authorization: Bearer {YOUR ORG TOKEN}' \
--header 'Content-Type: application/json' \
--data '
{
"config": {
"additional_attributes": [
{
"isDestinationAccepted": true,
"isSourceAccepted": true,
"isSuggestion": true,
"name": "check",
"source": [
"@alert.labels.alertname",
"@alert.labels.check",
"@alert.labels.alert",
"@alert.labels.sdesc",
"@alert.labels.short_desc",
"@alert.labels.title"
],
"suggestedDestination": "check",
"suggestedSources": [
"@alert.labels.alertname",
"@alert.labels.check",
"@alert.labels.alert",
"@alert.labels.sdesc",
"@alert.labels.short_desc",
"@alert.labels.title"
]
},
{
"isDestinationAccepted": true,
"isSourceAccepted": true,
"isSuggestion": true,
"name": "application",
"source": [
"@alert.labels.app_name",
"@alert.labels.application",
"@alert.labels.app",
"@alert.labels.impacted_app"
],
"suggestedDestination": "application",
"suggestedSources": [
"@alert.labels.app_name",
"@alert.labels.application",
"@alert.labels.app",
"@alert.labels.impacted_app"
]
},
{
"isDestinationAccepted": true,
"isSourceAccepted": true,
"isSuggestion": true,
"name": "assignment_group",
"source": [
"@alert.labels.assignment_group",
"@alert.labels.support_group",
"@alert.labels.routing_group",
"@alert.labels.escalation_group",
"@alert.labels.workgroup"
],
"suggestedDestination": "assignment_group",
"suggestedSources": [
"@alert.labels.assignment_group",
"@alert.labels.support_group",
"@alert.labels.routing_group",
"@alert.labels.escalation_group",
"@alert.labels.workgroup"
]
},
{
"isDestinationAccepted": true,
"isSourceAccepted": true,
"isSuggestion": true,
"name": "description",
"source": [
"@alert.labels.summary",
"@alert.labels.ldesc",
"@alert.labels.long_desc",
"@alert.labels.problem"
],
"suggestedDestination": "description",
"suggestedSources": [
"@alert.labels.summary",
"@alert.labels.ldesc",
"@alert.labels.long_desc",
"@alert.labels.problem"
]
},
{
"isDestinationAccepted": true,
"isSourceAccepted": true,
"isSuggestion": true,
"name": "host",
"source": [
"@alert.labels.host",
"@alert.labels.hostname",
"@alert.labels.instance",
"@alert.labels.device",
"@alert.labels.machine",
"@alert.labels.server",
"@alert.labels.hosts",
"@alert.labels.node"
],
"suggestedDestination": "host",
"suggestedSources": [
"@alert.labels.host",
"@alert.labels.hostname",
"@alert.labels.instance",
"@alert.labels.device",
"@alert.labels.machine",
"@alert.labels.server",
"@alert.labels.hosts",
"@alert.labels.node"
]
},
{
"isDestinationAccepted": true,
"isSourceAccepted": true,
"isSuggestion": true,
"name": "location",
"source": [
"@alert.labels.location",
"@alert.labels.physical_location",
"@alert.labels.device_location"
],
"suggestedDestination": "location",
"suggestedSources": [
"@alert.labels.location",
"@alert.labels.physical_location",
"@alert.labels.device_location"
]
},
{
"isDestinationAccepted": true,
"isSourceAccepted": true,
"isSuggestion": true,
"name": "priority",
"source": [
"@alert.labels.priority",
"@alert.labels.severity",
"@alert.labels.inc_priority"
],
"suggestedDestination": "priority",
"suggestedSources": [
"@alert.labels.priority",
"@alert.labels.severity",
"@alert.labels.inc_priority"
]
},
{
"isDestinationAccepted": true,
"isSourceAccepted": true,
"isSuggestion": true,
"name": "service",
"source": [
"@alert.labels.service",
"@alert.labels.impact_service",
"@alert.labels.srvc"
],
"suggestedDestination": "service",
"suggestedSources": [
"@alert.labels.service",
"@alert.labels.impact_service",
"@alert.labels.srvc"
]
},
{
"isDestinationAccepted": true,
"isSourceAccepted": true,
"isSuggestion": true,
"name": "cmdb_ci",
"source": [
"@alert.labels.impacted_ci",
"@alert.labels.configuration_item",
"@alert.labels.ci_name"
],
"suggestedDestination": "cmdb_ci",
"suggestedSources": [
"@alert.labels.impacted_ci",
"@alert.labels.configuration_item",
"@alert.labels.ci_name"
]
},
{
"isDestinationAccepted": true,
"isSourceAccepted": true,
"isSuggestion": true,
"name": "business_group",
"source": [
"@alert.labels.business_unit",
"@alert.labels.logical_group",
"@alert.labels.lob"
],
"suggestedDestination": "business_group",
"suggestedSources": [
"@alert.labels.business_unit",
"@alert.labels.logical_group",
"@alert.labels.lob"
]
},
{
"isDestinationAccepted": true,
"isSourceAccepted": true,
"isSuggestion": true,
"name": "impact",
"source": [
"@alert.labels.inc_impact"
],
"suggestedDestination": "impact",
"suggestedSources": [
"@alert.labels.inc_impact"
]
},
{
"isDestinationAccepted": true,
"isSourceAccepted": true,
"isSuggestion": true,
"name": "urgency",
"source": [
"@alert.labels.inc_urgency"
],
"suggestedDestination": "urgency",
"suggestedSources": [
"@alert.labels.inc_urgency"
]
},
{
"isDestinationAccepted": true,
"isSourceAccepted": true,
"isSuggestion": true,
"name": "environment",
"source": [
"@alert.labels.env",
"@alert.labels.tier",
"@alert.labels.stage"
],
"suggestedDestination": "environment",
"suggestedSources": [
"@alert.labels.env",
"@alert.labels.tier",
"@alert.labels.stage"
]
},
{
"isDestinationAccepted": true,
"isSourceAccepted": true,
"isSuggestion": true,
"name": "network_device",
"source": [
"@alert.labels.router",
"@alert.labels.routers",
"@alert.labels.switch",
"@alert.labels.switches",
"@alert.labels.hub",
"@alert.labels.repeater",
"@alert.labels.bridge",
"@alert.labels.gateway "
],
"suggestedDestination": "network_device",
"suggestedSources": [
"@alert.labels.router",
"@alert.labels.routers",
"@alert.labels.switch",
"@alert.labels.switches",
"@alert.labels.hub",
"@alert.labels.repeater",
"@alert.labels.bridge",
"@alert.labels.gateway "
]
},
{
"isDestinationAccepted": true,
"isSourceAccepted": true,
"isSuggestion": true,
"name": "cluster",
"source": [
"@alert.labels.rack",
"@alert.labels.tower"
],
"suggestedDestination": "cluster",
"suggestedSources": [
"@alert.labels.rack",
"@alert.labels.tower"
]
},
{
"isDestinationAccepted": true,
"isSourceAccepted": true,
"isSuggestion": true,
"name": "runbook_url",
"source": [
"@alert.labels.runbook_link",
"@alert.labels.knowledge_base",
"@alert.labels.ki_article",
"@alert.labels.support_link",
"@alert.labels.kb_article",
"@alert.labels.wiki_url"
],
"suggestedDestination": "runbook_url",
"suggestedSources": [
"@alert.labels.runbook_link",
"@alert.labels.knowledge_base",
"@alert.labels.ki_article",
"@alert.labels.support_link",
"@alert.labels.kb_article",
"@alert.labels.wiki_url"
]
},
{
"isSuggestion": false,
"source": [
"@alert.startsat"
]
},
{
"isSuggestion": false,
"source": [
"@alert.endsat"
]
},
{
"isSuggestion": false,
"source": [
"@alert.generatorurl"
]
},
{
"flatten": true,
"isSuggestion": false,
"source": [
"@alert.annotations"
]
},
{
"flatten": true,
"isSuggestion": false,
"source": [
"@alert.labels"
]
},
{
"isSuggestion": false,
"source": [
"@alert.labels.instance",
"@alert.labels.job",
"@alert.labels.alertname"
]
},
{
"isSuggestion": false,
"source": [
"@alert.labels.monitor",
"@alert.labels.alertname"
]
}
],
"array_source": "alerts",
"is_array": true,
"map_remaining": false,
"primary_property": [
{
"name": "host"
},
{
"name": "application"
},
{
"name": "service"
}
],
"secondary_property": [
{
"name": "check"
},
{
"name": "description"
}
],
"status": {
"default_to": "critical",
"source": [
"@alert.status",
"@alert.labels.severity"
],
"status_map": {
"acknowledged": [
"acknowledged"
],
"critical": [
"page",
"critical"
],
"ok": [
"resolved"
],
"warning": [
"warn",
"warning"
]
}
},
"timestamp": {
"source": [
"@alert.annotations.timestamp",
"@alert.startsat",
"@alert.endsat"
]
},
"version": "2.0"
},
"sample_payload": {
"alerts": [
{
"annotations": {
"description": "This alert is used to check the CPU utilization of this non-existent server",
"runbook_url": "https://runbook.io/cpu-check"
},
"endsAt": "0001-01-01T00:00:00Z",
"fingerprint": "123456789",
"generatorURL": "https://some-url.io",
"labels": {
"alertname": "BigPanda Test",
"env": "test",
"instance": "bigpanda-server",
"job": "CPU Check",
"locale": "ca",
"severity": "page",
"team": "metrics",
"timestamp": "1.657051103137505e+09"
},
"startsAt": "2022-07-05T19:59:25.661Z",
"status": "firing"
}
],
"commonAnnotations": {
"description": "This alert is used to check the CPU utilization of this non-existent server",
"runbook_url": "https://runbook.io/cpu-check"
},
"commonLabels": {
"alertname": "BigPanda Test",
"env": "test",
"instance": "bigpanda-server",
"job": "CPU Check",
"locale": "ca",
"team": "metrics",
"timestamp": "1.657051103137505e+09"
},
"externalURL": "https://external-url.io",
"groupLabels": {
"alertname": "BigPanda Test",
"env": "test",
"instance": "bigpanda-server",
"job": "CPU Check",
"locale": "ca",
"team": "metrics",
"timestamp": "1.657051103137505e+09"
},
"receiver": "bigpanda",
"status": "firing",
"version": "4"
}
}