Putting a Service in Maintenance Mode

Follow

A Maintenance Window is used to temporarily disable a service, including all of the integrations for the service, for a set period of time. While that service is disabled under a maintenance window, that service is considered to be in maintenance mode.

No new incidents will be triggered and no notifications will be sent while a service is disabled or in maintenance mode. Putting a service in maintenance mode will not resolve any existing incidents; they will remain open until resolved.

When a maintenance window ends, the service will immediately exit maintenance mode and incidents can start triggering again.

There are 3 ways to put a service into maintenance mode. From the service's page in the web UI:

  1. Schedule Maintenance
  2. Disable Service
  3. Immediate Maintenance

 

How to schedule a maintenance window

  1. Go to Configuration > Services

  2. Click the gear icon on the service you'd like to put into maintenance mode, and select Schedule Maintenance

  3. In the Create New Maintenance Window dialog, enter the start and end time, and any additional notes in the description field.

  4. When you are done, click Create Maintenance Window.

The Maintenance Windows tab at Configuration > Services will show maintenance windows across all services, and you can review upcoming maintenance windows as well as any maintenance windows currently progress, for a specific service from that service's page. 

How to disable a service

From a service's page, click Disable Service. After confirming the prompt, the service will be indefinitely disabled, and you'll need to click Enable this service before incidents can trigger on this service again.

How to immediately put a service into maintenance mode

  1. Go to Configuration > Services

  2. Click on the name of the service you would like to put into immediate maintenance, and from the Service Maintenance box on the righthand side of the page, select how many minutes you would like to place your service under maintenance (5, 15, 30, or 60 minutes).

After confirming the prompt, the service will be immediately placed under maintenance and new incidents will not be triggered during the timespan you selected.

If you need to set up a recurring maintenance window, this article covers various ways to achieve that using the REST API.

How to verify your service is in maintenance mode

There are a number of visual clues to show a service is in maintenance mode:

  1. An in-maintenance service has a  icon on the Services page (disabled services have a  icon)

  2. An in-maintenance service will also have a  In Maintenance icon on its service's page   

How to take a service out of maintenance

  1. Go to Configuration > Services

  2. Click on the name of the service in maintenance mode

  3. Click on the Edit button in the Service Maintenance box on the righthand side of the page

  4. In the Edit Maintenance Window box, you can change the maintenance window's end time or End this maintenance window now

  5. Clicking End this maintenance window now will have an immediate effect.

Have more questions? Submit a request

Comments