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 Endpoint | https://api.bigpanda.io/resources/v1.0/schedules |
| Supported Methods | POST, GET, PATCH |
Parameters
The Alert Filter Schedule object schema includes the following attributes:
| Attribute | Description | Type |
|---|---|---|
| id | System-generated unique identifier for the schedule. | String |
| name | User defined name for the schedule. | String |
| description | Brief summary of the schedule. | String |
| starts_on | Unix epoch time when the schedule starts (in seconds). | Long |
| ends_on | Unix epoch time when the schedule ends (in seconds). | Long |
| time_zone | The schedule's time zone setting. Default is UTC. See the full list of supported time zones here. | String |
| duration | The calculated time between the ends_on and starts_on in seconds. | Long |
| created_on | Unix epoch time when the schedule was created (in seconds). | Long |
| created_by | The ID of the user who created the schedule. | String |
| updated_on | Unix epoch time when the schedule was last updated (in seconds). | Long |
| updated_by | The ID of the user who last updated the schedule. | String |
| active | Indicates 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
}