Skip to main content

Incidents V1

Deprecation Coming

BigPanda has a new Incidents API with additional functionality including:

  • Query searches with incident tag, folder and environment support

  • The ability to split, merge, comment, snooze, and assign incidents through the API

Take a look at the improved Incidents API here!You can continue to use this V1 API, but we recommend moving to the V2 API wherever possible.

The Incidents API allows you to build integrated functionality between an external ticketing or collaboration system and BigPanda. It provides the Incidents object, which represents a BigPanda incident containing correlated alerts from your integrated monitoring systems.

Use the Incidents API to retrieve, snooze, or resolve an incident in BigPanda.

Incidents v1

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. Retrieve an incident
curl --request GET \
     --url https://api.bigpanda.io/resources/v1.0/incidents/1235553b6789c12d3efg45h \
     --header 'Authorization: Bearer <ORG TOKEN>' \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json; charset=utf8' \
curl --request GET \
     --url https://eu-api.bigpanda.io/resources/v1.0/incidents/1234555b6789c12d3efg45h \
     --header 'Authorization: Bearer <ORG TOKEN>' \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json; charset=utf8' \


Example 2. Retrieve an incident with expanded alert data
curl --request GET \
     --url https://api.bigpanda.io/resources/v1.0/incidents/1234a5556789c12d3efg45h?expand=alerts \
     --header 'Authorization: Bearer <ORG TOKEN>' \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json; charset=utf8' \


Example 3. Resolve or add a comment to an incident
curl --request POST \
     --url https://api.bigpanda.io/resources/v1.0/incidents/1e5555ed5fow65ieof018f8 \
     --header 'Authorization: Bearer <ORG TOKEN>' \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --data '{ "resolved": true, "comments": "ServiceNow ticket was resolved" }'
curl --request POST \
     --url https://eu-api.bigpanda.io/resources/v1.0/incidents/1e5555ed5fow65ieof018f8 \
     --header 'Authorization: Bearer <ORG TOKEN>' \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --data '{ "resolved": true, "comments": "ServiceNow ticket was resolved" }'


In this section: