Status · Guides

Plan maintenance

A maintenance window is a time when downs are expected. Checks go on, but nobody is woken, and your status page can say that work is going on.

Plan a window

On the project's Maintenance page, choose Plan a window. You need the editor or admin role.

From and To: now or later, at most a week long. For longer, pause the monitors instead.
Covers: every monitor, or the monitors of one environment, such as staging.
Note (optional): what customers read when it's announced, such as "Database upgrade: short breaks in the API."
Announce it on the public page: ticked, the page lists it from a week before, and says Under maintenance while it runs.

Choose Plan window. The page lists each window with when it runs, the monitors it covers and whether it's announced, and the ones that ended in the last two weeks.

Start one from a script

A deploy script can open a window from now, for 1 to 240 minutes, with the project's server secret (Get a server secret):

Terminal

curl -fsS -X POST https://services.my-beast.com/status/api/v1/maintenance \
  -H "Authorization: Bearer $MYBEAST_STATUS_SECRET" \
  -H "Content-Type: application/json" \
  -d '{"minutes": 10, "note": "Deploying", "environment": "production", "public": true}'

Response

{
  "id": 12,
  "starts_at": "2026-11-01T12:00:00+00:00",
  "ends_at": "2026-11-01T12:10:00+00:00"
}

Leave out environment to cover every monitor. public is false unless you say otherwise. The fields are in the API reference.

What happens during a window

Checks and pings go on, and count in the uptime as ever.
A down that starts inside the window is told to nobody: no incident, no alert, no webhook. If it's still down when the window ends, it's told then, like any down.
On the public page, the monitors a running window covers show Maintenance, not down. An announced window also makes the page's head say Under maintenance.
The project's overview lists the latest windows, with what the checks said after each.

End a window early

On the Maintenance page, a running window has End now, and a planned one can be removed from its menu. From a script, this ends every window that is running: