CLI reference

norcube monitor maintenance create

Schedule a maintenance window, or start one now

Not verified yet

Schedules a window. Without --start it begins right away. It needs a title, at least one target, and --end or --duration; it can last at most 30 days and start at most a year ahead.

It shows by itself on every published status page displaying a target, and subscribers get all three mails unless you turn them off with --notify-scheduled, --notify-started, --notify-finished or --no-notify. A window that starts within 15 minutes sends no scheduled mail, only the started one.

A CI token needs the monitor.maintenance scope, and monitor.statuspages too when the window shows on a published page.

Usage

norcube monitor maintenance create [flags]

Examples

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

# Announce work for tomorrow on everything a status page shows
norcube monitor maintenance create --status-page acme --title "Database upgrade" --description "Short interruptions are expected." --start 2026-11-07T14:00:00Z --end 2026-11-07T16:00:00Z

# A quiet window nobody hears about
norcube monitor maintenance create --monitor "Shop API" --monitor "Shop cert" --title "Load test" --start +1h --duration 2h --no-notify

Flags

FlagDefaultDescription
--componentA manual status page component to mark, by id or exact name (repeatable)
--descriptionWhat is happening; public on a published status page and in mail
--durationHow long it lasts, counted from its start: 15m, 2h, 7d (at most 30 days)
--endWhen it ends: an RFC 3339 timestamp, now, or a span from now (+2h, +7d)
--monitorA monitor to hold, by id or exact name (repeatable); domain monitors can't be held
--no-notifyTurn off all three mails; a cancellation still tells whoever was told
--notify-finishedtrueEmail subscribers when it finishes
--notify-scheduledtrueEmail subscribers when it is scheduled
--notify-startedtrueEmail subscribers when it starts
--startWhen it starts, if not now: an RFC 3339 timestamp, now, or a span from now (+2h, +7d)
--status-pageEverything a status page shows right now, by id or exact slug (repeatable); something added to the page later isn't included
--titleThe window's title; public on a published status page

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

See also

On this page