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 | https://api.bigpanda.io/resources/v1.0/plans |
| Supported Methods | POST, GET, PATCH, DELETE |
Parameters
The Alert Filter Plan object schema includes the following attributes:
| Attribute | Description | Type |
|---|---|---|
| id | System-generated unique identifier for the alert filter. | String |
| name | User defined name for the alert filter. | String |
| description | Brief summary of the alert filter. | String |
| bpql | The BPQL object to identify which alerts will be filtered. | JSON |
| exclude_status | A 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 |
| active | Whether the filter is active and will apply to incoming alerts | Boolean |
| created_on | Date and time the filter was created in ISO 8601 format. | Long |
| created_by | The ID of the user who created the filter. | String |
| updated_on | Date and time the filter was last updated in ISO 8601 format. | Long |
| updated_by | The ID of the user who last updated the filter. | String |
| schedule | The ID of the schedule associated to the filter. | String |
| custom_tags | Metadata about the plan in an array of key-value pairs. Attributes: - 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"
}]
}