Alert Filter Schedules
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.
Alert Filter Schedules allow you to control when an alert filter should start and stop. By default, alert filters apply to all matching alerts until deactivated.
See the Alert Filter Plans API for more details on adding schedules to new or existing alert filters.
Schedule ID
The schedule ID will be included in the success return. This ID is needed to add the schedule to a filter.
Relevant Permissions
Roles with the following permissions can access the Schedules v1 API:
Permission | Description |
|---|---|
Schedules (API Only) | View and use the Alert Filter Schedules API to define the specific start and end times of alert filters. |
Permission access levels can be adjusted by selecting either View or Full Access. To learn more about how BigPanda's permissions work, see the Roles Management guide.
Alert Filter Schedule Object
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 |
|
Supported Methods |
|
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. | |
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:
```a Sample Alert Filter Schedule
{
"name": "Weekend Maintenance",
"starts_on": 1491265491,
"ends_on": 1491294307,
"time_zone": "UTC",
"active": true
}
```