Skip to main content

OIM Alerts

The Open Integration Manager enables you to create customizable inbound alert integrations through the configuration of a generic inbound integration rather than creating custom code. The integration manager sets parsing rules for incoming payloads, preprocessing the content to match incoming data requirements before it reaches the BigPanda enrichment engine.

The OIM Alerts API allows you to easily integrate a monitoring system with BigPanda. Monitoring systems generally send out events when problems are detected and when problems have been resolved.

The API receives event payloads from a monitoring system. Incoming events sent via the API are processed according to OIM settings and BigPanda alert correlation logic. Depending on the results of the correlation, the system then creates a new incident or updates an existing incident based on Event Aggregation rules.

Configuration

To manage integration configuration rules for the Open Integration Manager via API, use the OIM Configuration API.

Note

The Open Integration Manager offers additional flexibility with authentication parameters. The following syntax can be used for the Token and App Key:

Auth Token:

query string: access_token=<token>

header: Authorization: Bearer <token>

header: x-auth-token: <token>

App Key

Query string: app_key=<app_key>

header: x-app-key: <app_key>

header: app_key: <app_key>

body: { "app_key": "<app_key>" }

Open Integration Manager (OIM) Alerts

Authentication

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

This API uses the Org Token type of Authorization token.

BigPanda recommends adding Authentication headers only in the secure tool you use to make API calls.

Example 1. Send an alert to BigPanda
curl -request POST \
    -url https://integrations.bigpanda.io/oim/api/alerts \
    -header 'Content-Type: application/json' \
    -header 'Authorization: Bearer <ORG TOKEN>' \
    -data '{ "app_key": "<app_key>",
    "status": "critical",
    "host": "production-database-1",
    "check": "CPU overloaded",
    "timestamp": 1402303570,
    "application": "Billing",
    "regions":["US1","US2","EMEA"],
    "count": 47,
    "description": "CPU is above warning limit (40%)",}'
curl -request POST \
    -url https://eu.integrations.bigpanda.io/oim/api/alerts \
    -header 'Content-Type: application/json' \
    -header 'Authorization: Bearer <ORG TOKEN>' \
    -data '{ "app_key": "<app_key>",
    "status": "critical",
    "host": "production-database-1",
    "check": "CPU overloaded",
    "timestamp": 1402303570,
    "application": "Billing",
    "regions":["US1","US2","EMEA"],
    "count": 47,
    "description": "CPU is above warning limit (40%)",}'


Example 2. Sending multiple alerts to BigPanda
curl -request POST \
    -url https://integrations.bigpanda.io/oim/api/alerts \
    -header 'Content-Type: application/json' \
    -header 'Authorization: Bearer <ORG TOKEN>' \
    -data '{ "app_key": "<app_key>",
          "alerts": [{
               "status": "critical",
               "host": "production-database-1",
               "check": "CPU overloaded",
               "description": "CPU is above warning limit (40%)"
           }, {
               "status": "critical",
               "host": "production-database-2",
               "check": "CPU overloaded",
               "timestamp": 1402303570,
               "application": "Billing"
           }]
       }'
curl -request POST \
    -url https://eu.integrations.bigpanda.io/oim/api/alerts \
    -header 'Content-Type: application/json' \
    -header 'Authorization: Bearer <ORG TOKEN>' \
    -data '{ "app_key": "<app_key>",
          "alerts": [{
               "status": "critical",
               "host": "production-database-1",
               "check": "CPU overloaded",
               "description": "CPU is above warning limit (40%)"
           }, {
               "status": "critical",
               "host": "production-database-2",
               "check": "CPU overloaded",
               "timestamp": 1402303570,
               "application": "Billing"
           }]
       }'


In this section: