Use the Incident Tags REST API to assign tags to your incidents.
Incident Tags allow you to add context specific to your organization. You can add Incident Tags to Incidents through the BigPanda UI or via this API. Note that you first need to configure an incident tag definition in order to apply it to incidents.
To learn more about how the Incident Tags feature works, see our Add Tags to Incidents user guide.
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.
Relevant Permissions
Incident Tags permissions are defined by environment role access. To search incident tags, you will need permission to view incidents in the specified environment. To edit incident tags, you will need incident action permissions in the specified environment.
Environment ID
The environment ID can extracted from the URL of the BigPanda console in browser, or it can be retrieved through the Environments API
| Permission | Description |
|---|---|
Environments_Read | Retrieve incident tags for incidents in any environment |
Environments_Incident_Actions | Retrieve, or edit incident tags for incidents in any environment |
Environments_Full_Access | Retrieve, or edit incident tags for incidents in any environment |
*_Read | Granular - Retrieve incident tags for incidents in the specified environment |
*_Incident_Actions | Granular - Retrieve, or edit incident tags for incidents in the specified environment |
See the Incidents in BigPanda documentation or a full explanation of the permissions required to access the Incidents Settings section and the Incident Tags API.
To learn more about how BigPanda's permissions work, see the Roles Management guide.
Available Actions
Use the Incident Tags API to perform these actions:
| Action | Definition | Description |
|---|---|---|
| Add an Incident Tag to an Incident | POST /environments/{env_id}/incidents/{incident_id}/tags/{tag_id} | Create or update an incident tag for a single incident. |
| Add Multiple Incident Tags to an Incident | POST /environments/{env_id}/incidents/{incident_id}/tags | Create or update multiple incident tags for a single incident. |
| Retrieve an Incident Tag from an Incident | GET /environments/{env_id}/incidents/{incident_id}/tags/{tag_id} | Retrieve a single incident tag of a single incident by ID. |
| Retrieve All Tags for an Incident | GET /environments/{env_id}/incidents/{incident_id}/tags | Retrieve all incident tags from a single incident. |
| Delete an Incident Tag from an Incident | DELETE /environments/{env_id}/incidents/{incident_id}/tags/{tag_id} | Delete a single incident tag of a single incident by ID. |
| Delete All Tags for an Incident | DELETE /environments/{env_id}/incidents/{incident_id}/tags | Delete all incident tags for a single incident by ID. |