CLI reference

norcube monitor maintenance

Schedule maintenance windows that pause alerts and stay out of uptime

Not verified yet

A maintenance window is planned work on monitors or status page components. While it runs, its monitors don't alert or open incidents for availability problems, and the time stays out of their uptime. Checks keep running and count towards your usage. A certificate or domain running out still alerts, because that is true whatever work is going on.

A window shows by itself on every published status page displaying one of its targets, and subscribers get mail when it is scheduled, starts and finishes unless you turn that off. Which pages show it isn't a choice: otherwise a page could stay green while its alerts are silent.

A CI token changes windows with the monitor.maintenance scope, and also needs monitor.statuspages when a window shows on a published page. Cancelling or finishing needs only monitor.maintenance, so whoever can edit a window can always end its silence. Any Norcube Monitor scope reads them.

A window ends by itself, so a deploy that dies before "finish" can't silence alerts for longer than you asked for. Wrap a deploy in one:

id=$(norcube monitor maintenance create --monitor api --title "Deploy" --duration 15m -o id)
./deploy.sh
norcube monitor maintenance finish "$id"

Usage

norcube monitor maintenance <command> [flags]

Also available as: maintenance-windows.

Commands

CommandDescription
cancelCall off a maintenance window that hasn't started
createSchedule a maintenance window, or start one now
finishEnd a maintenance window in progress now
getShow a maintenance window, its targets and the pages it shows on
listList maintenance windows, latest start first
updateChange a maintenance window, as far as where it stands allows

Every command also takes the global flags: --profile, --org, -o, --query, --debug and more.

See also

  • norcube monitor: Monitor uptime, SSL certificates and domain expiry, and manage incidents and alerts

On this page