Alert and Incident Management APIs
API | Description |
|---|---|
Resolve individual alerts in bulk. | |
Retrieve incident data, merge incidents, or add comments to incidents in BigPanda | |
Incidents (Deprecating soon) | Retrieve incident data or update an existing incident. |
Relevant Permissions
Resolver permissions are defined by environment role access. To resolve alerts, a user will need access to take action on alerts in the specified environment or all environments.
Name | Permissions |
|---|---|
| Resolve alerts from any environment |
| Resolve alerts from any environment |
| Granular - Resolve alerts from the specified environment |
To learn more about how BigPanda's permissions work, see the RBAC - Role Based Access Control guide.
Authentication
All BigPanda APIs require Bearer Token Authorization in the call headers.
This API uses the User API Key type of Authorization token.
BigPanda recommends adding Authentication headers only in the secure tool you use to make API calls.
Batch Alert Resolution Rate limitations
To maintain quality of service, the Batch Alert Resolution API is limited to 1 call per second with no more than 500 alerts per request
Additional requests will return a 429 response code and the request will need to be retried.
API rate limitations
To maintain quality of service, BigPanda APIs are limited to 5 requests per second. Additional requests will return a 429 response code and the request will need to be retried.
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.