Maintenance windows temporarily disable a service, including all of the integrations for the service, for a set period of time. A service disabled under a maintenance window is considered to be in maintenance mode.
No new incidents will be triggered while a service is in maintenance mode. Existing incidents will not resolve; they will remain open and continue to notify users on the expected escalation policy until manually resolved.
When a maintenance window ends the service will immediately exit maintenance mode and incidents can start triggering again.
Required User Permissions
Admin, Manager, Global Admin or Account Owner roles can manage maintenance windows.
If you're not sure what role you have, or if you need your permissions adjusted, visit our sections on Checking Your User Role or Changing User Roles.
Schedule Maintenance
Disable a Service
From a service's page, click More, select Disable Service, and confirm the disable prompt. This service is now indefinitely disabled; click More and select Enable to allow incidents to trigger on this service again.
Immediately Put a Service in Maintenance Mode
- Go to Services Service Directory.
- Click on the name of the service you would like to put into immediate maintenance.
- In the Activity tab, scroll to the bottom and click +New Maintenance Window.
- Your service will already be populated under Which services are affected?, you may optionally select other services from the dropdown if there are others you wish to put in maintenance mode.
- Under Why is this maintenance happening? enter a brief description to give team members context.
- Select *Start now and end in and select the end time of 15 minutes, 30 minutes, 60 minutes, 2 hours or 4 hours and click Create Maintenance Window**.
Schedule a Maintenance Window
- Go to Services Service Directory.
- Click on the name of the service you would like to put into immediate maintenance.
- In the Activity tab, scroll to the bottom and click +New Maintenance Window.
- Your service will already be populated under Which services are affected?, you may optionally select other services from the dropdown if there are others you wish to put in maintenance mode.
- Under Why is this maintenance happening? enter a brief description to give team members context.
- Select Start at a Scheduled Time and select your Time Zone. Enter window start and end dates and times in dialogue window.
- Click Create Maintenance Window.
Confirm that a Service is in Maintenance Mode
- The Maintenance Windows tab at Services Service Directory Maintenance Windows shows current, future, and past maintenance windows across all services.
- appears next to a service on the Services page.
- appears next to a service on the Services page.
- In Maintenance appears at the top of a service's individual page.
End Maintenance Mode
- Go to Services Service Directory and select the Maintenance Windows tab.
- Under All Maintenance Windows, find your desired maintenance window and click Update to its right.
- Click the red End Now button the end the maintenance window.
Recurring Maintenance Mode for Services
If you perform regularly scheduled maintenance that results in notifications being sent from your monitoring system to PagerDuty, you can use our API to create recurring maintenance windows in PagerDuty to prevent incidents from being triggered during these maintenance periods.
We've created a few different tools to help make this process easy for users who prefer a web UI, as well as those who would rather work in the command line:
- Ruby 2.x Compatible Script (pd_maintenance_windows_v2.rb) (Note: You will need a v2 REST API key.)
- Python 2 Compatible Script (Note: You will need a v2 REST API key.)
Please note the Ruby scripts will not run as is, but require you to substitute your own values for the variables at the points indicated in the source code. Once the substitutions have been made, the script will allow you to create maintenance windows programmatically.
Other values as set in the script you may want to change also. For instance, the maintenance start and end time are 2 hours apart; please change this to adjust the length of time for the maintenance window. The script as written will also create 20 maintenance windows, separated from each other by a week's time; please adjust these values to either adjust the number of windows or the length of time between windows.
FAQ
Will incidents created before the service is put in maintenance mode be automatically resolved?
No; existing open incidents will remain in their current state.
Moreover, incidents will not be automatically resolved through the Events API either. Maintenance mode is like flipping the "off" switch for all integrations; no actions can be taken through the Events API for all of that service's integrations when it is in a maintenance period, or disabled.
Updated about a month ago