Maintenance Plans V1

Maintenance Plans allow for the suppression of events. Use the Maintenance Plans API to define time windows that parallel infrastructure changes of respective monitored services.

🚧

Disclaimer

Please note that this feature is available through the Beta program only and is not released for general availability. If you would like to request access to the Beta program and use this feature, please contact [email protected]

The Maintenance Plan API supports two new resources to control the maintenance windows: plans (required) and schedules (optional).

Plans are configured with BPQL queries and, once activated, will filter/suppress events that matches the criteria. Origin tags supplied by a monitoring source and automatically generated enriched tags by the Enrichment API are also supported for querying. User created tags from the Custom Tags Editor are not supported.

Schedules define a start and stop time frame which can be applied to a Plan. Once a Schedule is deactivated, the Plan will cease to continue filtering. If a Plan does not have a Schedule defined, it will start immediately and run indefinitely - until an administrator manually deletes the plan or updates it to inactive.

Relevant Permissions

See the Maintenance Plans V2 (Beta) guide for a full explanation of the permissions required to access the Maintenance Plans section, the Plans V1 API and the Maintenance Plans V2 (Beta) API:

To learn more about how BigPanda's permissions work, see the RBAC - Role Based Access Control guide.

Use Cases

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.

Available Objects & Actions

Object

Description

Supported Methods

API Endpoint

Plans Objects

Defines the schema for configuring a plan and schedule.

POST, GET, PATCH, DELETE

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

Use the Plans API to perform these actions:

Actions

Create Plan — Creates a new schema definition for creating a plan.

Create Schedule — Creates a new schema definition for creating a schedule.

Create Plan with Schedule and Custom Tags — Creates a new schema definition for creating a plan with schedule and custom tags.

Retrieve Plan — Retrieves a specific schema definition for a created plan.

Update Plans — Updates a specific plan to stop maintenance period immediately.

List All Plans — Lists all plan schema definitions that exist for an organization.

Delete Plan — Lists all plan schema definitions that exist for an organization.

🚧

Rate Limitations

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.