Alert Object

Defines the schema for an alert within incidents in BigPanda

🚧

Expanding Alert Data

To include the full alert object for each retrieved incident, include expand=alerts in the query.

When making a call with alerts expanded, page size cannot be larger than 10. An expanded call with a page size greater than 10 will return a 400 error.

Parameters

The Alert object schema includes the following attributes:

Parameter

Description

Type

Example

id

System-generated unique identifier for the alert

String

"id": "60800a8012d7dd0464f1b87d"

status

The most severe status the alert triggered

Possible returns are: critical, warning, unknown, ok

String

"status" : "critical"

start

Unix time when the alert was received

Timestamp (in seconds)

"start": 1466416853

end

Unix time when the alert was resolved

Timestamp (in seconds)

"end": null

changed_at

Unix time when the alert status last changed

Timestamp (in seconds)

"changed_at": 1466417169

updated_at

Unix time of last change to the alert

Timestamp (in seconds)

"updated_at": 1466417169

last_event_at

Unix time of the last alert event

Timestamp (in seconds)

"last_event_at": 1466417169

active

Whether the alert is active and has not been manually resolved.

Boolean

"active": true

primary_property

Main object that triggered the alert

String

“primary_property”: “host”

secondary_property

Secondary object or sub-item that triggered the alert

String

“secondary_property”: “check”

source_system

Integrated monitoring system that sent the alert to BigPanda

String

"source_system": "api.backend_monitoring"

incident_key

A unique id BigPanda uses to recognize if two events are related to each other

String

"incident_key" : “prod-mwv2-demo-1__Host is down”

maintenance_plans

If alert is in maintenance, returns the plan ids

Array

“maintenance_plans”: “60450a8012d7dd0464f1b87dl”

description

Brief summary (max. 2048 characters) of the alert included by certain monitoring tools

String

"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.

String

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