Skip to main content
Version: 1.4 (Current)

Creating and managing

Route: /maintenance-windows

See also: Overview · Impact on alerts

Create a maintenance window​

  1. Open Management → Maintenance Windows.
  2. Click Create maintenance window.
  3. Fill in the drawer fields (see below).
  4. Click Create.

Create maintenance window drawer

Form fields​

FieldRequiredDescription
DescriptionYesWhat maintenance is happening (shown in the table)
EnvironmentYesTarget environment — autocomplete from known alert environments
PriorityYesNumeric priority when several windows match the same alert (lower number = higher priority). Default: 0
Time RangeYesEnter the start time and Enter the end time (date-time pickers). Duration is shown below the range. Dates before yesterday are disabled
ResourceNoLimit to one resource (prefix icon in the field). If empty, saving triggers a confirmation for an environment-wide window
EventNoLimit to one event type
GroupNoSelect from existing alert groups
OriginNoMulti-select origins (create new values allowed)
TagNoMulti-select tags (field label is singular "Tag" even though it accepts multiple values)
ServiceNoMulti-select services

A Copy demo alert JSON button next to Create copies a sample alert payload matching the window's current scope — useful for testing with the API.

Empty optional fields mean “match any value” for that dimension — see Impact on alerts.

Environment-wide confirmation​

If you leave Resource empty and click Create, ToBeAlert asks you to confirm before applying the window to the whole Environment. Use Continue to proceed or Cancel to go back and narrow the scope.

English UI note

The confirmation string may appear as a translation key in English builds; the intent is to warn that all open alerts in the environment can enter Maintenance while the window is active.

Edit, duplicate, enable, disable, delete​

ActionHow
EditClick Description, double-click the row, or bulk Edit (one row). Footer button: Update
DuplicateBulk Duplicate — copies selected windows
EnableBulk Enable — sets Start Time to now and End Time to one hour later (reactivates expired windows)
DisableBulk Disable — sets range to the last hour ending now (effectively expires the window). Disabled when the single selected row is already expired
DeleteRow trash icon or bulk Delete — confirmation required

Closing the drawer with unsaved edits shows the standard unsaved-changes prompt.

Tip: Right-click a maintenance window row to open a context menu with the same actions (Edit, Duplicate, Enable/Disable, Delete).

Table columns​

ColumnDescription
DescriptionWindow description (click to edit)
EnvironmentTarget environment
PriorityNumeric priority
Start Time / End TimeActive range
Statusactive, pending, or expired
Create TimeWhen the window was created
Tags, Service, Resource, Event, Group, UserScope and metadata
ActionsEdit, Delete (with permission)

For sorting, Column manager, pagination, row selection, and bulk actions, see List tables and bulk actions. On this screen, pagination persists in the URL (page, size).

Search and filters​

The list search bar uses placeholder Enter the description or identifier. Plain text filters as you type; the TQL ON / TQL OFF tag enables structured TQL filters. Shared behavior — syntax, autocomplete, plain vs TQL — is in TQL search and filters.

Examples for maintenance window columns:

  • status:eq:active
  • environment:eq:production
  • description:contains:patch
  • resource:contains:web
  • priority:lt:5

Maintenance windows list — plain search

Maintenance windows list — TQL filter

Maintenance windows list — TQL autocomplete

Example scenarios​

Database patch on one host​

FieldValue
DescriptionDB patch — web-server-01
Environmentproduction
Resourceweb-server-01
Time RangeToday 02:00 – 04:00
Priority0

Planned network maintenance for a service​

FieldValue
DescriptionCore switch upgrade
Environmentproduction
Servicenetwork-core
Tagsmaintenance, change-window
Time RangeSaturday 22:00 – Sunday 06:00

Staging environment freeze (wide scope)​

FieldValue
DescriptionStaging freeze — release prep
Environmentstaging
Resource(empty — confirm environment-wide)
Time RangeFriday 18:00 – Monday 08:00
Priority5

Best practices​

  • Match Time Range to the real maintenance slot; pad 15–30 minutes if needed for slow systems.
  • Prefer Resource or Service over environment-wide windows.
  • Use Duplicate for recurring patterns, then adjust dates.
  • Disable instead of Delete if you may reuse the same definition soon.
  • Document the change ticket or owner in Description for audit trails.