Alerts Object

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 not been resolved.

"active": true

startedOn

Time when the alert was first received, in Unix epochs.

"startedOn": 146641685

changedOn

Time of last change to the alert status, in Unix epochs.

"changedOn": 1466417169

updatedOn

Time of last change to alert, in Unix epochs.

"updatedOn": 1466417169

endedOn

Time when the alert status was set to ok, in Unix epochs.

"endedOn": null

primary_property

Main object that cause the alert. See Primary property.

"primary_property": "host"

secondary_property

Secondary object or sub-item that caused 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: Tag values are limited to 15 items and/or 512 characters total.

"tags":[ {"name":"host","value":"production-database-1"}, {"name":"check","value":"CPU load"} ]