Incidents Object

Defines the schema for an incident in BigPanda.

API Endpoint

https://api.bigpanda.io/resources/v1.0/incidents

Supported Methods

POST, GET

Parameters

The Incidents object schema includes the following attributes.

id

System-generated unique identifier for the incident.

"id": "1234a53b6789c12d3efg45h"

status

Current incident status, which is determined by the most severe status of the correlated alerts. One of [critical, warning, unknown, ok].

"status" : "critical"

active

Whether the incident contains at least one active alert and has not been manually resolved. An incident is automatically resolved when all the alerts are resolved.

"active": true

flapping

Whether at least one correlated alert has changed states frequently enough to be treated as flapping.

"flapping": false

resolved

Whether the incident is currently resolved (true) or active (false).

"resolved": false

snooze

Snooze options for the incident.

Attributes:

  • snoozed - Whether the incident is currently snoozed.
  • wake - Time when the current snooze period expires, in Unix epochs.
  • autoCancel - Whether the current snooze is automatically cancelled if a new alert is added, the severity of an existing alert increases, or the incident is resolved and then reopens.
"wake" : null, "autoCancel" : false}```

startedOn

Time when the earliest correlated alert was received, in Unix epochs.

"startedOn": 1466416853

changedOn

Time of last change to incident that triggered applicable sharing updates, in Unix epochs.

"changedOn": 1466417169

updatedOn

Time of last change to incident, in Unix epochs.

"updatedOn": 1466417169

endedOn

Time when the incident was resolved, either manually or automatically when all alerts were resolved, in Unix epochs.

"endedOn": null

alerts

Array of the alerts that the incident contains.

Attributes:

  • alertID - System-generated unique identifier for the alert.
"alertId": "68eb89e35dca2g4b65df36b1",
 "alertId": "79fc79f46egh3h5c78rg78d2" } ]```