Defines the schema for an alert that is contained in a BigPanda incident.
| API Endpoint | https://api.bigpanda.io/resources/v1.0/incidents/{incident ID}/alerts/ |
|---|---|
| Supported Methods | GET |
Parameters
The Alerts object schema includes the following attributes:
| Attribute | Description | Example |
|---|---|---|
| id | System-generated unique identifier for the alert. | "id": "57da76d24cdb1f3a54ce25a0" |
| status | Current state of the alert. One of [critical, warning, unknown, ok]. | "status" : "critical" |
| active | Whether the alert has been resolved. | "active": true |
| startedOn | Unix epoch time when the alert was first received (in seconds). | "startedOn": 146641685 |
| changedOn | Unix epoch time when the last change to alert status occurred (in seconds). | "changedOn": 1466417169 |
| updatedOn | Unix epoch time when the last change to an alert occurred (in seconds). | "updatedOn": 1466417169 |
| endedOn | Unix epoch time when the alert status was set to ok (in seconds). | "endedOn": null |
| primary_property | Main object that triggered the alert. See Primary property. | "primary\_property": "host" |
| secondary_property | Secondary object or sub-item that triggered the alert. | "secondary\_property": "check" |
| source_system | Integrated monitoring system that sent the alert to BigPanda, in the following format: <source type>.<integration name>. | "source\_system": "nagios.nagios\_east" |
| description | Brief summary (max. 2048 characters) of the alert for certain monitoring tools. | "description": "CRITICAL - Host Unreachable" |
| tags | Array of name-value pairs that represent alert properties. Attributes: - name - Tag name in BigPanda. - value - Tag value in BigPanda. Note: By default, tag values are limited to a maximum of 30 items. Each value supports up to 512 characters before truncation. If you want to increase the value limit, reach out to your BigPanda account team. | "tags":\[ {"name":"host","value":"production-database-1"}, {"name":"check","value":"CPU load"} \] |