Maintenance Plans V2
Use the Maintenance Plans API to define time windows that parallel infrastructure changes of respective monitored services.
Maintenance Plans are configured in BPQL Object format and, once activated, mark events that match the criteria for maintenance. Origin tags supplied by a monitoring source and enriched tags automatically generated by the Enrichment API are also supported for querying.
Maintenance Plans
Authentication
All BigPanda APIs require Bearer Token Authorization in the call headers.
This API uses the User API Key type of Authorization token.
BigPanda recommends adding Authentication headers only in the secure tool you use to make API 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 | 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: Default is | 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"
}
Available time zones
The Maintenance Plan API supports the following time zones for the time_zone object.
UTC
EST
CST
MST
AST
PST
Africa/Addis_Ababa
Africa/Algiers
Africa/Brazzaville
Africa/Cairo
Africa/Casablanca
Africa/Dakar
Africa/Dar_es_Salaam
Africa/Djibouti
Africa/Douala
Africa/Freetown
Africa/Gaborone
Africa/Harare
Africa/Johannesburg
Africa/Juba
Africa/Kampala
Africa/Khartoum
Africa/Kigali
Africa/Kinshasa
Africa/Lagos
Africa/Libreville
Africa/Lome
Africa/Luanda
Africa/Lusaka
Africa/Malabo
Africa/Maputo
Africa/Maseru
Africa/Mbabane
Africa/Mogadishu
Africa/Monrovia
Africa/Nairobi
Africa/Ndjamena
Africa/Niamey
Africa/Nouakchott
Africa/Porto-Novo
Africa/Sao_Tome
Africa/Tripoli
Africa/Tunis
America/Anguilla
America/Antigua
America/Aruba
America/Asuncion
America/Bahia
America/Barbados
America/Bogota
America/Buenos_Aires
America/Cancun
America/Caracas
America/Catamarca
America/Cayenne
America/Cayman
America/Chicago
America/Chihuahua
America/Cordoba
America/Costa_Rica
America/Creston
America/Cuiaba
America/Curacao
America/Detroit
America/Dominica
America/Edmonton
America/El_Salvador
America/Fortaleza
America/Grenada
America/Guadeloupe
America/Guatemala
America/Guayaquil
America/Guyana
America/Halifax
America/Havana
America/Hermosillo
America/Indianapolis
America/Jamaica
America/Juneau
America/La_Paz
America/Lima
America/Los_Angeles
America/Louisville
America/Managua
America/Manaus
America/Marigot
America/Martinique
America/Mendoza
America/Menominee
America/Merida
America/Mexico_City
America/New_York
America/Monterrey
America/Montevideo
America/Montserrat
America/Nassau
America/Panama
America/Paramaribo
America/Phoenix
America/Puerto_Rico
America/Recife
America/Santiago
America/Sao_Paulo
America/Sitka
America/St_Johns
America/St_Kitts
America/St_Lucia
America/St_Thomas
America/St_Vincent
America/Thule
America/Tijuana
America/Vancouver
America/Winnipeg
Asia/Aden
Asia/Almaty
Asia/Amman
Asia/Anadyr
Asia/Aqtau
Asia/Aqtobe
Asia/Ashgabat
Asia/Atyrau
Asia/Baghdad
Asia/Bahrain
Asia/Baku
Asia/Bangkok
Asia/Barnaul
Asia/Beirut
Asia/Bishkek
Asia/Brunei
Asia/Calcutta
Asia/Chita
Asia/Choibalsan
Asia/Colombo
Asia/Damascus
Asia/Dhaka
Asia/Dili
Asia/Dubai
Asia/Dushanbe
Asia/Famagusta
Asia/Hong_Kong
Asia/Hovd
Asia/Irkutsk
Asia/Jakarta
Asia/Jayapura
Asia/Jerusalem
Asia/Kabul
Asia/Kamchatka
Asia/Karachi
Asia/Katmandu
Asia/Khandyga
Asia/Krasnoyarsk
Asia/Kuala_Lumpur
Asia/Kuching
Asia/Kuwait
Asia/Macau
Asia/Magadan
Asia/Makassar
Asia/Manila
Asia/Muscat
Asia/Nicosia
Asia/Novokuznetsk
Asia/Novosibirsk
Asia/Omsk
Asia/Oral
Asia/Phnom_Penh
Asia/Pontianak
Asia/Pyongyang
Asia/Qatar
Asia/Qostanay
Asia/Qyzylorda
Asia/Rangoon
Asia/Riyadh
Asia/Saigon
Asia/Sakhalin
Asia/Samarkand
Asia/Seoul
Asia/Shanghai
Asia/Singapore
Asia/Srednekolymsk
Asia/Taipei
Asia/Tashkent
Asia/Tbilisi
Asia/Tehran
Asia/Thimphu
Asia/Tokyo
Asia/Tomsk
Asia/Ulaanbaatar
Asia/Urumqi
Asia/Vientiane
Asia/Vladivostok
Asia/Yakutsk
Asia/Yekaterinburg
Asia/Yerevan
Atlantic/Azores
Atlantic/Bermuda
Atlantic/Canary
Atlantic/Cape_Verde
Atlantic/Faeroe
Atlantic/Madeira
Atlantic/Reykjavik
Atlantic/St_Helena
Australia/Adelaide
Australia/Brisbane
Australia/Broken_Hill
Australia/Currie
Australia/Darwin
Australia/Eucla
Australia/Hobart
Australia/Lindeman
Australia/Lord_Howe
Australia/Melbourne
Australia/Perth
Australia/Sydney
Europe/Amsterdam
Europe/Andorra
Europe/Athens
Europe/Belgrade
Europe/Berlin
Europe/Bratislava
Europe/Brussels
Europe/Bucharest
Europe/Budapest
Europe/Chisinau
Europe/Copenhagen
Europe/Dublin
Europe/Gibraltar
Europe/Guernsey
Europe/Helsinki
Europe/Isle_of_Man
Europe/Istanbul
Europe/Jersey
Europe/Kaliningrad
Europe/Kiev
Europe/Kirov
Europe/Lisbon
Europe/Ljubljana
Europe/London
Europe/Luxembourg
Europe/Madrid
Europe/Malta
Europe/Mariehamn
Europe/Minsk
Europe/Monaco
Europe/Moscow
Europe/Oslo
Europe/Paris
Europe/Podgorica
Europe/Prague
Europe/Riga
Europe/Rome
Europe/Samara
Europe/San_Marino
Europe/Sarajevo
Europe/Saratov
Europe/Simferopol
Europe/Skopje
Europe/Sofia
Europe/Stockholm
Europe/Tallinn
Europe/Tirane
Europe/Ulyanovsk
Europe/Uzhgorod
Europe/Vaduz
Europe/Vatican
Europe/Vienna
Europe/Vilnius
Europe/Volgograd
Europe/Warsaw
Europe/Zagreb
Europe/Zaporozhye
Europe/Zurich
Indian/Antananarivo
Indian/Chagos
Indian/Christmas
Indian/Cocos
Indian/Comoro
Indian/Kerguelen
Indian/Mahe
Indian/Maldives
Indian/Mauritius
Indian/Mayotte
Indian/Reunion
Pacific/Auckland
Pacific/Fiji
Pacific/Funafuti
Pacific/Galapagos
Pacific/Guadalcanal
Pacific/Guam
Pacific/Honolulu
Pacific/Midway
Pacific/Nauru
Pacific/Niue
Pacific/Norfolk
Pacific/Noumea
Pacific/Pago_Pago
Pacific/Palau
Pacific/Pitcairn
Pacific/Saipan
Pacific/Tahiti