Check Maintenance windows are used to temporarily suspend alerting and uptime calculations while a check is expected to experience outages. Maintenance Windows can be set on an ad-hoc basis or scheduled for the future based on expected downtime. If a check is expected to experience downtime due to scheduled maintenance to systems or other connectivity issues, we recommend using Maintenance Windows to mitigate unnecessary alerts or impacts to SLA calculations as opposed to pausing the check. Using Maintenance Windows allows for exact timing, provides logs for future reference, and reduces the chances of human error.
Table of Contents
- Overview of Check Maintenance Windows
- Quick Guide: Creating a Maintenance Schedule
- Maintenance Dashboard
- Maintenance Bulk Actions
- Maintenance Bulk Actions
- Pausing Check Execution During Maintenance Mode
- Maintenance and Group Checks
- FAQ
Overview of Check Maintenance Windows
Use check maintenance windows to identify periods where downtime or reduced response time is expected, and alerts should not be sent. During Maintenance, failed check alerts will be ignored in uptime calculations. Alerts are still logged, but they will not issue notifications to check contacts. Escalations are also ignored while a check is in maintenance.
Navigate to Monitoring to see the number of your checks that are in Maintenance mode. Checks in this state are denoted by the wrench icon. Checks with future scheduled maintenance display a clock icon:
Maintenance Check Behavior
In the Alert history, alerts for a check that is in maintenance state are automatically marked Ignored:
When a check is in maintenance state, Uptime.com will stop issuing alerts for the check until the maintenance schedule ends. During this period, Uptime.com will still log data for response or downtime for later review, though alerts are not sent. If you choose to have the check paused while maintenance is running. Statistics will not show any change of status during the maintenance time. Once the maintenance window has ended, the check will issue an alert (and corresponding escalations) if it still reports as down.
Check Maintenance is the preferred alternative to manually pausing a check because maintenance only ignores alerts for the specified period, and maintenance windows require less human input to return the check to a normal state. In addition, you may always see the “real state” of the check on our Dashboard whilst the check is under maintenance. Maintenance can be set to:
- No Maintenance Window: no maintenance is currently active
- Under Maintenance Now: all failed checks are ignored until the feature is returned to No Maintenance Window
- Link Schedule: associate the check with an existing window that has been created through the maintenance dashboard
Quick Guide: Creating a Maintenance Schedule
Here’s a quick guide to creating a maintenance schedule for your checks. Further explanations of each field are in the Setting Maintenance Windows section of this document.
To create a new Maintenance Schedule:
- Click Maintenance in the side menu
- Click the Create Schedule button
- Add Name (We recommend being specific: “Maintenance for London Server”)
- “Pause Checks during Maintenance” is enabled by default. Disable this option if you want the check to run while the check is in maintenance
- Add the Start Date, Duration (Minutes, Hours or Days), and the frequency
- Add schedule tags to easily locate this maintenance window
- Navigate to the Affected Checks tab
- Add the checks that will be associated with this schedule by clicking their names in the Checks Available list on the left. Use the Search, Type, and Tags options to quickly locate your checks.
Once your checks are associated, click Create.
All done! Your maintenance window is created and your checks will not report outages in the maintenance period.
Maintenance Dashboard
Uptime.com's Maintenance dashboard is a standalone option in the menu bar. It works separately from individual check settings, which are located under the Maintenance tab when creating or editing a check. Click Maintenance in the menu to view all your currently active and scheduled maintenance.
The Maintenance Windows view shows several data points for each of your maintenance windows:
- Name: the name of the maintenance window
- Status: the current status of the window (scheduled, in maintenance, resolved)
- Next Scheduled: if the maintenance is scheduled for the future, the date and time when it will be active
- Repeat: the repeat behavior of the window (doesn’t repeat, repeats every Saturday, etc.)
- Duration: the length of time that the maintenance window will last
- Checks Used In: the number of checks this maintenance window is applied to (click to see the check names)
- Tags: a count of the tags associated with the check. Click the number to view checks
You can create a schedule once and apply it to multiple checks without editing each one individually. Schedules can be reusable and recurring, so you can adjust which checks are affected without recreating the schedule from scratch.
Click Maintenance in the menu bar to open the Maintenance dashboard. The dashboard has three main tabs:
- Active – Shows schedules currently running. Use the search box or filters to find a specific check that is actively under maintenance.
- Schedules – Shows all schedules you've created. Like the Active tab, you can search and filter to locate specific schedules. This is where you'll manage upcoming maintenance before it starts.
- Event Log – A record of all maintenance activity: when schedules were created, started, ended, and modified. You can search, filter, and export logs (formats: CSV, Excel, JSON) for compliance or audit purposes.
Maintenance Bulk Actions
We provide on both the Active and Schedules pages of the maintenance windows, the option to use bulk actions to enhance efficiency.
On the Active page, if you select the checkbox icon, this will allow you to end the maintenance schedules in bulk.
The bulk actions on the Schedules page, will allow you to delete all the schedules, or select the ones you want to delete.
Managing Your Schedules
Once saved, your schedule will appear in different locations depending on its timing:
- Active Tab – While the schedule is running
- Schedules Tab – For future or past schedules
-
Event Log – A record of when it started, ran, or ended
Viewing Linked Checks
On any tab, you can view which checks are linked to a schedule by clicking the Affected Check number (Active, Event Log) or Checks Used In (Schedules).
Schedule Actions
Each schedule has actions menu (three dots icon):
On the Active Tab:
- End Maintenance – Stop the schedule immediately (useful if maintenance finishes early)
- Edit – Modify the active schedule without losing the record
On the Schedules Tab:
- Edit – Update the schedule details before it starts
- Duplicate – Create a copy
- Delete – Remove the schedule permanently
Setting Maintenance Windows
Create a maintenance window by clicking Maintenance > Create Schedule. The Create Maintenance Schedule view appears:
The Create Maintenance Schedule feature includes three tabs for configuring your schedule: General, Affected Checks, and Notifications.
General
Use the General tab to set the basic options for your maintenance schedule.
Name: the name of the schedule as it will appear in your internal account
Pause Checks during Maintenance: when this is enabled, affected checks will not run while the maintenance schedule is active. If you want the check to continue running while maintenance is active, for example to still gather response time metrics through a known maintenance window, enable this option. Note that alerts will still not be sent when this option is enabled.
Start Date/Time: the day and time the schedule will start
Duration: length of the schedule, set in minutes, hours, or days
Frequency: the interval at which the schedule will activate
- Don’t Repeat: create a one-off schedule that will only apply for the time and duration you set, and will not repeat
- Daily: repeat the schedule on a daily basis at the time you specify
- Weekly: repeat the schedule on a weekly basis at the day of the week and time you specify
- Monthly: repeat the schedule on a monthly basis at the day of the week, or specific day of the month, at the time you specify
- Custom: create custom rules for your schedule, with options as follows:
- Repeat on a day basis: for example, repeat every 3 days
- Repeat on a weekly basis: for example, Friday of every week
- Repeat on a monthly basis: for example, day 4 of every month or the 1st Monday of every month
Schedule Tags: associate tags with the schedule for easier filtering and searching
Note that currently basic configuration options are also available using the REST API under the following endpoints:
GET /api/v1/maintenance/schedules/
POST /api/v1/maintenance/schedules/
GET /api/v1/maintenance/schedules/{pk}/
PUT /api/v1/maintenance/schedules/{pk}/
PATCH /api/v1/maintenance/schedules/{pk}/
DELETE /api/v1/maintenance/schedules/{pk}/
Affected Checks
The Affected Checks tab is where you will define the checks associated with the maintenance schedule.
Add the checks that will be associated with this schedule by clicking their names in the Checks Available list on the left. Checks that will be associated with the schedule are displayed in the Checks Selected list on the right. Search by check name in the Manually Select Checks field, and filter by Check Type and Tag to quickly locate your checks. Once checks are added to the list, any checks that are already associated with a schedule will include an “In Schedule” notification.
Notifications
Use the Notifications tab to schedule reminders to your contacts about future maintenance, or to inform them that a maintenance window is ending.
Create as many reminders as necessary by setting the contacts to receive notifications through their designated channels either before the maintenance schedule starts, or within the end of the maintenance. The options available in the Notify box are the ones you have already defined in your Contacts:
Setting Maintenance Windows in Bulk
You can also set maintenance windows on multiple checks or link to maintenance schedules using bulk actions. For more information, see our documentation on bulk edits here.
Pausing Check Execution During Maintenance Mode
Stop check execution during maintenance mode: when this option is checked while creating the maintenance schedule, checks will be paused for the duration of the schedule. This may be useful in cases where URLs should not be hit by our probe servers during maintenance to avoid undesirable effects on infrastructure.
To find the setting, you will need to go to the Maintenance Menu, find the maintenance window under “Schedules” and edit it. Under the “General” tab you will find the check box to “Pause Checks during Maintenance”..
In the case this was a manually set maintenance simply edit the check in question and under the Maintenance tab you will find the toggle “Stop check execution during maintenance mode” which you can select.
This setting can also be found within our REST API endpoint:
- /api/v1/maintenance/schedules/{pk}/
Please note: all maintenance windows are set based on your account's preferred timezone. It is possible to use the Uptime.com REST API to set maintenance windows. It is also possible to set maintenance windows in bulk.
Maintenance and Group Checks
A Group Check nests individual checks, and maintenance windows apply differently to this check type. If an individual check is in maintenance state, that check’s UP or DOWN state counts toward the fail conditions for your Group Check.
A Group Check in this sense can be considered like an individual check. If the checks within a group check should not count against the group check’s downtime, it is advised to set the group check and the individual checks to the same maintenance schedule.
FAQ
Will check maintenance windows affect my status page?
Creating a maintenance window for a check or checks will not automatically update or change a status page. Although checks may be linked to components on a status page, placing the check under maintenance does not automatically create a corresponding maintenance window for the components on a status page. To have your status page components under a proper maintenance window, it will be necessary to set Status Page Maintenance.
Comments
0 comments