Defines the schema for configuring a maintenance plan.
| API Endpoint | https://api.bigpanda.io/resources/v2.0/maintenance-plans |
|---|---|
| Supported Methods | POST, GET, PATCH, DELETE |
Additional object parameters will be added in-system upon creation of a maintenance plan. These fields should not be included in Post or Patch calls.
Parameters
The Maintenance Plans object schema includes the following attributes:
| Attribute | Description | Type |
|---|---|---|
| id | System-generated unique identifier for a maintenance plan. | String |
| status | The maintenance plan's status. | String |
| maintenance_key | Third party (Jira, ServiceNow, etc.) system key for integrated maintenance management. If no integration key is included in the call, a system ID will be added automatically. | String |
| name | User-defined name for the plan. | String |
| start | Unix epoch time when the scheduled plan starts (in seconds). For recurring plans, this time should be the start of the first maintenance window. | String |
| end | Unix epoch time when the scheduled plan ends (in seconds). For recurring plans, this time should be the date when the plan should stop repeating. | String |
| time_zone | The maintenance plan's time zone setting. Default is UTC. See the full list of supported time zones here. | String |
| condition | Maintenance condition in BPQL Object format. Cannot be longer than 80,000 characters. | String |
| frequency | How often the scheduled plan should silence alerts. One of: • Once • Daily • Weekly • Monthly Default is Once. This field is case-insensitive. | String |
| frequency_data | For recurring plans only. Defines the plan window when alerts should be silenced each period. See the Frequency Data Object table for detailed attributes. | Object |
| description | Brief user-defined summary of the maintenance plan. | String |
| custom_tags | Metadata about the plan in an array of key:value pairs. Attributes: name - name of the tag value - value of the tag | Array of Objects |
| created_at | System Field Unix epoch time when the plan was created (in seconds). | Integer |
| created_by | System Field The ID of the user who created the plan. | String |
| updated_at | System Field Unix epoch time when the plan was last updated (in seconds). | Integer |
| updated_by | System Field The ID of the user who last updated the plan. | String |
| post_maintenance_action | What should happen to alerts suppressed by this plan after the maintenance window ends. One of: Resolve, Reactivate, NoneDefault is None | String |
Frequency Data Object Parameters
The 'frequency_data' object schema includes the following attributes:
| Attribute | Description | Type |
|---|---|---|
| relativity | Required for plans using relative monthly dates. What week in the month the window should take place. One of: • First • Second • Third • Fourth • Last Last will trigger in the 5th week for months with a 5th week, and otherwise default to the 4th. | String |
| duration | Required for all recurring plans.The length of time the plan should run in milliseconds. | Integer |
| current_run | System-generated field. Unix epoch time when the current running maintenance window began (in seconds). | String |
| next_run | System-generated field. Unix epoch time when the next scheduled maintenance window starts (in seconds). | String |
Sample Object:
{ "id": "64f0d836310000a6bc72fa7a",
"status": "in progress",
"maintenance_key": "MNT-a9b9030cbda7",
"name": "host3 maintenance",
"condition": {
"=": [
"host",
"prod-api-1"
] },
"start": 1718029999,
"end": 1818029999,
"time_zone": "UTC",
"description": "this is a description",
"selected_source_system": null,
"custom_tags": [
{
"name": "App",
"value": "esp"
}
],
"created_by": "63bd568977a8d60012bf3dbe",
"created_at": 1693505590,
"updated_by": "63bd568977a8d60012bf3dbe",
"updated_at": 1718029640,
"frequency": "Daily",
"frequency_data": {
"duration": 10800000,
"current_run": 1720017199,
"next_run": 1720103599,
"relativity": "First"
},
"post_maintenance_action": "None"
}