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 it is considered to be in maintenance mode.

No new incidents will trigger while a service is in maintenance mode. Existing open incidents will not resolve; they will remain open and continue to notify users as expected unless they are manually resolved. When a maintenance window ends the service exits maintenance mode and new incidents can trigger again.

Additionally, while a service is in maintenance mode or disabled, incidents cannot be resolved through the Events API. Maintenance mode is like flipping an off switch for all of a service’s integrations.

🚧

Required User Permissions

The following roles can create/edit/delete maintenance windows:

  • User roles
  • Admin roles
  • Manager base roles and team roles
    • Manager team roles can only manage maintenance windows associated with their team.
  • Global Admin base roles
  • Account Owner base roles

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.

Immediately Put a Service in Maintenance Mode

  1. Go to Services Service Directory and select a service you’d like to put into maintenance mode.
  2. On the service’s detail page, select More ​​ Schedule Maintenance in the top right.
  3. 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.
  4. Under Why is this maintenance happening? enter a brief description to give team members context.
  5. Select *Start now and end in and one of the predefined intervals : 15 minutes, 30 minutes, 60 minutes, 2 hours or 4 hours**.
  6. Click Create Maintenance Window.

Schedule a Maintenance Window

  1. Go to Services Service Directory and select a service you’d like to schedule maintenance for.
  2. On the service’s detail page, select More ​​ Schedule Maintenance in the top right.
  3. 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.
  4. In the Activity tab, scroll to the bottom and click +New Maintenance Window.
  5. Under Why is this maintenance happening? enter a brief description to give team members context.
  6. Select Start at a scheduled time, select your Time Zone, and enter Start and End dates.
  7. Click Create Maintenance Window.

End Maintenance Mode

To end a maintenance window early:

  1. Go to Services Service Directory and select the Maintenance Windows tab.
  2. Under All Maintenance Windows, find your desired maintenance window and click Update to the right.
  3. Click End Now.

Disable a Service

If you’d like to indefinitely put a service into maintenance mode:

  1. Navigate to Services Service Directory and select a service to disable.
  2. Select More Disable Service.
  3. 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:

  1. Navigate to Services Service Directory and select a disabled service.
  2. Select More Enable Service.

New incidents can now trigger on the service.

Confirm that a Service is in Maintenance Mode

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.

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 scripts can be customized and run in the command line:

Please note that the scripts 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 script, too. For instance, the maintenance start and end time are two hours apart. Please change these values to adjust the maintenance windows’ duration. The script as written will also create 20 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.

LEARN MORE LINKS

Services and Integrations https://support.pagerduty.com/docs/services-and-integrations
Service Profile https://support.pagerduty.com/docs/service-profile


Did this page help you?