Maintenance Windows
Temporarily disable a service, along with its integrations and incidents
Maintenance windows temporarily disable a service, including all of its integrations, for a set period of time. While a service is in a maintenance window, all of a service’s integrations are effectively “switched off,” and no new incidents will trigger. When a maintenance window ends, incidents can trigger on the service again.
Existing open incidents will not resolve when a maintenance window begins; they will remain open and continue to notify users as expected unless they are manually resolved.
Additionally, while a service is in a maintenance window, incidents cannot be resolved through the Events API.
Availability
Maintenance windows are available on all pricing plans.
Required User Permissions
The following roles can create, edit and delete maintenance windows:
- User
- Manager base roles and team roles
- Manager team roles can only manage maintenance windows associated with their team.
- Admin/Global Admin
- Account Owner base roles
If you're not sure what role you have, or if you need your permissions adjusted, visit our sections Check Your User Role or Edit User Roles.
Maintenance Windows in the Web App
View Maintenance Windows
One quick way to review which services are in maintenance mode is to go to Services Service Directory Maintenance Windows tab. This page prominently displays all services that are currently in maintenance mode (Maintenance Happening Now).
Below that, the table All Maintenance Windows lists all future, ongoing and past maintenance windows. You can restrict results with a search term, service status or Team.
The Services tab also indicates which services are in maintenance mode. An icon indicates whether a service in maintenance mode:
- appears next to a service that is in maintenance mode.
- appears next to a service that is disabled.
On a service’s detail page, Maintenance appears under the Status heading while it is in maintenance mode.
Create a Maintenance Window
You have two options when creating a maintenance window:
Immediately Put a Service in Maintenance Mode
- Go to Services Service Directory and select a service you’d like to put into maintenance mode.
- On the service’s detail page, select More Schedule Maintenance in the top right.
- In the Create Maintenance Window modal, your service will already be populated under Which services are affected? and you may optionally select other services from the dropdown.
- Under Why is this maintenance happening? enter a brief description to give team members context.
- Select *Start now and end in and one of the predefined intervals : 15 minutes, 30 minutes, 60 minutes, 2 hours or 4 hours**.
- Click Create Maintenance Window.
Schedule a Maintenance Window
- Go to Services Service Directory and select a service you’d like to schedule maintenance for.
- On the service’s detail page, select More Schedule Maintenance in the top right.
- In the Create Maintenance Window modal, your service will already be populated under Which services are affected? and you may optionally select other services from the dropdown.
- In the Activity tab, scroll to the bottom and click +New Maintenance Window.
- Under Why is this maintenance happening? enter a brief description to give team members context.
- Select Start at a scheduled time, select your Time Zone, and enter Start and End dates.
- Click Create Maintenance Window.
Update a Maintenance Window
To update a current or future maintenance window:
- Navigate to Services Service Directory and select the Maintenance Windows tab.
- In the table All Maintenance Windows, click Update to the right of the maintenance window you’d like to update.
- In the Update Maintenance Window modal, update maintenance window’s details.
- Click Save Changes.
End a Maintenance Window
To end a maintenance window early:
- Go to Services Service Directory and select the Maintenance Windows tab.
- Under All Maintenance Windows, find your desired maintenance window and click Update to the right.
- Click End Now.
Disable a Service
If you’d like to indefinitely put a service into maintenance mode:
- Navigate to Services Service Directory and select a service to disable.
- Select More Disable Service.
- In the prompt, click Disable to confirm your selection.
This service is now indefinitely disabled and will not trigger incidents until it is manually enabled.
Enable a Service
To manually enable a disabled service:
- Navigate to Services Service Directory and select a disabled service.
- Select More Enable Service.
New incidents can now trigger on the service.
Maintenance Windows in the Mobile App
View Maintenance Windows
To view maintenance windows within the mobile app:
- Tap Service Directory and select your preferred service.
- Tap in the top-right corner.
- The list view displays all current and future maintenance windows for the selected service.
- Note: Any past or terminated maintenance windows are not displayed.
![View maintenance windows in the mobile app View maintenance windows in the mobile app](https://files.readme.io/c72c38b-maintenance_windows.png)
View maintenance windows in the mobile app
Create a Maintenance Window
You have two options when creating a maintenance window:
- Start Now: Start the maintenance window immediately.
- Schedule Later: Schedule the maintenance window for a future date and time.
Create Maintenance Windows for Multiple Services
In the mobile app, you can only create a maintenance window for one service at a time. If you'd like to create maintenance windows for multiple services at once, you can do this in the web app.
Start Now
To immediately start a maintenance window within the mobile app:
- Tap Service Directory and select your preferred service.
- Tap in the top-right corner.
- Tap Create Maintenance Window.
- Optional: In the section Description, tap Add Description, enter some text describing why the maintenance is happening, and tap Done.
- In the section Schedule Time, with the tab Start Now active, select one of the following predetermined durations:
- End in 15 Minutes
- End in 30 Minutes
- End in 60 Minutes
- End in 2 Hours
- End in 4 Hours
- Tap Create Maintenance Window.
- In the modal, confirm your selection.
![Start a maintenance window now Start a maintenance window now](https://files.readme.io/fd55d1d-Start_maintenance_window_now.png)
Start a maintenance window now
Schedule Later
To schedule a maintenance window for later within the mobile app:
- Tap Service Directory and select your preferred service.
- Tap in the top-right corner.
- Tap Create Maintenance Window.
- Optional: In the section Description, tap Add Description, enter some text describing why the maintenance is happening, and tap Done.
- In the section Schedule Time, select the tab Schedule Later and enter start and end times that outline when the maintenance window should be active.
- Optional: Tap Time Zone to set the start and end times in your preferred time zone.
- Tap Create Maintenance Window.
- In the modal, confirm your selection.
![Schedule a maintenance window later Schedule a maintenance window later](https://files.readme.io/3d420ac-Schedule_maintenance_window.png)
Schedule a maintenance window later
Update a Maintenance Window
To update a current or future maintenance window:
- Tap Service Directory and select the service with the maintenance window you'd like to update.
- Tap in the top-right corner. On the next screen, select the maintenance window you would like to update.
- Optional: In the section Description, tap Add Description, enter or update the text describing why the maintenance is happening, and tap Done.
- In the section Schedule Time, tap the End time row and select a new date and time.
- Tap Update Maintenance Window.
- In the modal, confirm your selection.
![Update a maintenance window in the mobile app Update a maintenance window in the mobile app](https://files.readme.io/ed35d35-image5.png)
Update a maintenance window in the mobile app
Update Maintenance Windows for Multiple Services
Please note that if a maintenance window affects multiple services (e.g., if you created the maintenance window in the web app and selected multiple services), updating the maintenance window will affect all associated services.
End a Maintenance Window
You can immediately end any in-progress maintenance window in the mobile app:
- Tap Service Directory and select the service with the maintenance window you'd like to end.
- Tap in the top-right corner.
- At the bottom of the screen, tap End Maintenance Window.
- In the confirmation modal, tap End Maintenance Window.
End Maintenance Windows for Multiple Services
Please note that if a maintenance window affects multiple services (e.g., if you created the maintenance window in the web app and selected multiple services), ending the maintenance window will affect all associated services.
Recurring Maintenance Windows
If you find that you need to regularly put your PagerDuty service into maintenance mode, you can use our API to create recurring maintenance windows. The following script can be customized and run in the command line:
- Python 3 Compatible Script (Note: You will need a REST API key).
Please note that the script above will not run as is, and require you to substitute your own email address, v2 REST API key and service ID where indicated. Once the substitutions have been made, the script will allow you to create maintenance windows programmatically.
You may wish to adjust other values in the example, too. For instance, the maintenance duration is set to 30 minutes. Please change this value to adjust the maintenance windows’ duration. The example as written will also create 8 maintenance windows, separated from each other by a week's time. Please adjust this value if you’d like a different number of maintenance windows.
Updated 2 days ago