Maintenance windows
A maintenance window is planned work on a schedule. While it runs, the monitors it covers aren’t checked, their alerts stay quiet, no incidents open, and the time doesn’t count against uptime. If a monitor is still down when the window ends, you’re alerted then.
Windows live on the Maintenance tab of the Incidents page: go to Incidents, then Maintenance.
Creating a maintenance window
Section titled “Creating a maintenance window”-
Go to Incidents, open the Maintenance tab, and click New maintenance.
-
Give the window a Name.
-
Under Monitors, choose what it covers:
- Choose monitors picks tunnels and checks from a searchable list.
- All tunnels or All Uptime checks covers every one in the project.
- A group… covers the monitors in one group.
-
Under Repeat, choose Once, Every day, or Every week. For a weekly window, pick the days, Mon to Sun.
-
Set From and To: a date and a time for a one-off window, or a time of day for one that repeats. Time zone starts as your browser’s.
-
Click Save maintenance.
To start from one monitor, choose Maintenance… from its row’s ⋯ menu in the list, or from the ⋮ menu on its own page. The form opens with that monitor already chosen.
What happens during a window
Section titled “What happens during a window”| While the window runs | |
|---|---|
| Checks | Paused for the monitors it covers |
| Alerts | Stay quiet |
| Incidents | None open |
| Webhooks | None sent |
| Uptime | The time doesn’t count against it |
When the window ends, checks start again. If a monitor is still down then, you’re alerted at that point, and monitor.down is sent to your webhooks.
Mute or maintenance?
Section titled “Mute or maintenance?”Muting holds one monitor’s alerts while its checks keep running, so incidents still open and close and webhooks still fire. Use it when you want a record of what happened without being paged. Use a maintenance window for planned work: checks pause, no incident opens, no webhook is sent, and the time doesn’t count against uptime.
The Maintenance page
Section titled “The Maintenance page”The page lists windows under In progress, Upcoming, and Past. Paused windows come last under Upcoming.
Each row shows:
- the window’s name, and what it covers, such as “All tunnels in Larkspur VPN”, “Group Frankfurt”, or “2 tunnels and 1 check”;
- when it runs, such as “Every Sunday, 02:00–03:00”, “Every day, 01:00–01:30”, or “Sat 1 Nov, 22:00 – Sun 2 Nov, 02:00”. The time zone appears in brackets, such as “(UTC+05:00)”, only when it differs from yours;
- where it stands: “Ends at 03:00”, “Starts in 14 hours”, “Paused”, or “Ended”.
A row’s ⋮ menu has Edit, Pause (or Resume), and Delete. Delete asks you to confirm. Deleting a window that’s running makes alerts start again at once.
How a monitor shows a window
Section titled “How a monitor shows a window”While a window covers a monitor:
- its row or card in the Tunnels and Uptime lists reads Maintenance · 40m left, counting down in minutes, hours, or days;
- its own page reads In maintenance until 03:00 under its name, followed by the window’s name, which links to the Maintenance page.
On your status pages
Section titled “On your status pages”Every status page that shows a service the window covers shows the window too: its name, its note, and when it runs. It appears up to 7 days before it starts, and stays while it runs. A page with tabs in its header lists them under Maintenance, and the page’s RSS and Atom feeds carry them too. A paused window isn’t shown.
Who can manage windows
Section titled “Who can manage windows”Anyone in the project can see its windows. Creating, editing, pausing, or deleting one needs a role that can mute and pause monitors: Owner, Admin, and Manager by default (see Roles). A window belongs to one project and can cover only that project’s monitors.
From the API, the CLI, or an AI assistant
Section titled “From the API, the CLI, or an AI assistant”- The REST API can list, plan, change, pause, end, and cancel windows.
- An AI assistant can do the same, except cancel a window when it’s signed in: use the dashboard or an API key for that. A window you plan is public at once on your status pages, so a good assistant confirms the times with you first.
- The CLI has
thq maintenance, from its next release.
Each uses the same windows and rules as the Maintenance page, and needs the same role.