Alert Filter Schedule Object

The schema for configuring an alert filter schedule.

📘

Renamed API

The Alert Filter Schedules API was previously called Schedules V1. The functionality of the API has not changed, but the name has been updated to clarify which BigPanda feature the API manages.

API Endpointhttps://api.bigpanda.io/resources/v1.0/schedules
Supported MethodsPOST, GET, PATCH

Parameters

The Alert Filter Schedule object schema includes the following attributes:

AttributeDescriptionType
idSystem-generated unique identifier for the schedule.String
nameUser defined name for the schedule.String
descriptionBrief summary of the schedule.String
starts_onUnix epoch time when the schedule starts (in seconds).Long
ends_onUnix epoch time when the schedule ends (in seconds).Long
time_zoneThe schedule's time zone setting. Default is UTC. See the full list of supported time zones here.String
durationThe calculated time between the ends_on and starts_on in seconds.Long
created_onUnix epoch time when the schedule was created (in seconds).Long
created_byThe ID of the user who created the schedule.String
updated_onUnix epoch time when the schedule was last updated (in seconds).Long
updated_byThe ID of the user who last updated the schedule.String
activeIndicates if the schedule is active and can be applied to alert filters.Boolean

Sample Object:

{
    "name": "Weekend Maintenance",
    "starts_on": 1491265491,
    "ends_on": 1491294307,
    "time_zone": "UTC",
    "active": true
  }