Alert Filter Plan Object

Defines the schema for configuring an alert filter.


Renamed API

The Alert Filter Plans API was previously called V1 Maintenance Plans or V1 Plans. 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 MethodsPOST, GET, PATCH, DELETE


The Alert Filter Plan object schema includes the following attributes:

idSystem-generated unique identifier for the alert filter.String
nameUser defined name for the alert filter.String
descriptionBrief summary of the alert filter.String
bpqlThe BPQL object to identify which alerts will be filtered.JSON
exclude_statusA list of alert status values that will be excluded from the filter. With new filters, the OK status is excluded by default unless exclude_status is explicitly declared in the payload.Array of Strings
activeWhether the filter is active and will apply to incoming alertsBoolean
created_onDate and time the filter was created in ISO 8601 format.Long
created_byThe ID of the user who created the filter.String
updated_onDate and time the filter was last updated in ISO 8601 format.Long
updated_byThe ID of the user who last updated the filter.String
scheduleThe ID of the schedule associated to the filter.String
custom_tagsMetadata about the plan in an array of key-value pairs.

- name - Ordered pair tuple name. String
- value - Object value. String
Array of Objects

Sample Object:

        "name": "Folsom Patch",
        "bpql": {"=": ["host", "prod-api-1"]},
        "active": true,
        "description": "Patching Folsom server farm",
        "custom_tags" : [{
        	 "name": "server_farm",
           "value": "folsom"