The Plans v1 API enables users to set and maintain maintenance windows and alert filters to reduce noise for operators.
Plans are configured with BPQL queries and, once activated, will suppress alerts that match the criteria.
The Plans v1 API can be used to manage Alert Filters that have been configured in the BigPanda API. Alert filters affect alerts after they have been normalized and enriched, enabling complex filters based on additional metadata and enrichment tags. The
plan ID for alert filters is the last 24 characters in the filter URL.
Schedules define a start and stop time frame for the plan or alert filter. If a plan does not have a schedule defined, it will start immediately and run indefinitely - filtering all matching alerts until deactivated.
The schedule ID is needed to add the schedule to a plan or filter.
See the Maintenance Plans V2 guide for a full explanation of the permissions required to access the Maintenance Plans section, the Plans V1 API and the Maintenance Plans V2 API:
To learn more about how BigPanda's permissions work, see the Roles Management guide.
You can use the Maintenance Plan API to keep in sync with infrastructure changes and parallel your monitoring activity accordingly. For example, the set of servers under a certain host, i.e. Billing, is scheduled to undergo upgrades for a duration of one week. Due to the non-operational nature of the servers during this time, all alerts generated by them will be unnecessary for monitoring.
Instead of having these alerts continue to stream into the feed and disrupt workflow, create a matching
Plan with the query
host = "billing*" and a
Schedule of one week in the same time frame as the upgrades. This will suppress the irrelevant alerts from ever entering the feed.
Each organization can only have 3,500 V1 maintenance plans (Also called alert filters).
Maintenance plan conditions cannot be longer than 25,000 characters.
conditionbody parameter uses special BPQL object formatting. See BPQL Object Syntax for more information.
|Object||Description||Supported Methods||API Endpoint|
|Plans Objects||Defines the schema for configuring a plan and schedule.|
Use the Plans API to perform these actions:
|Create a Plan||Creates a new schema definition for creating a plan.|
|Retrieve a Plan||Retrieves a specific schema definition for a created plan.|
|Retrieve All Plans||Retrieves the schema definitions for all plans.|
|Update a Plan||Updates a specific plan to stop the maintenance period immediately.|
|Delete a Plan||Lists all plan schema definitions that exist for an organization.|
To maintain quality of service, BigPanda APIs are limited to 5 requests per second.
Additional requests will return a 429 response code and the request will need to be retried.