Learn more about Maintenance Windows in the Maintenance Windows documentation.
Configuration
Parameter | Type | Required | Default | Description |
---|---|---|---|---|
name | string | ✅ | - | Name of the maintenance window |
startsAt | Date | ✅ | - | Start date and time (ISO 8601 timestamp) |
endsAt | Date | ✅ | - | End date and time (ISO 8601 timestamp) |
tags | string[] | ✅ | - | Tags that filter which checks are affected |
repeatInterval | number | ❌ | - | Repeat interval from the first occurrence |
repeatUnit | string | ❌ | - | Repeat strategy: 'WEEK' | 'MONTH' | 'YEAR' |
repeatEndsAt | Date | ❌ | - | When to stop repeating (ISO 8601 timestamp) |
MaintenanceWindow
Options
A name for the maintenance window that will be displayed in the Checkly dashboard and used for identification.Usage:Use cases: Window identification, dashboard display, maintenance tracking.
Tags that filter which checks are affected by this maintenance window. Checks with ANY of these tags will be paused during the maintenance period to avoid unnecessary alerts.Usage:Use cases: Service targeting, environment isolation, maintenance scope control.
Maintenance windows affect ALL checks that have ANY of the specified tags. Be specific with your tags to avoid affecting unintended checks.
Start date and time for the maintenance window in UTC (ISO 8601 timestamp).Usage:Use cases: Scheduled downtime, emergency maintenance, recurring maintenance timing.
End date and time for the maintenance window in UTC (ISO 8601 timestamp).Usage:Use cases: Maintenance duration control, downtime limitation, schedule coordination.
Repeat interval from the first occurrence. Used with Use cases: Regular maintenance scheduling, automated recurring downtime, consistent maintenance intervals.
repeatUnit
to create recurring maintenance windows.Usage:Repeat strategy that defines the time unit for recurring maintenance windows (Examples:Use cases: Time-based recurrence patterns, maintenance scheduling consistency, automated repetition.
DAY
| WEEK
| MONTH
).Usage:When to stop repeating the maintenance window (ISO 8601 timestamp in UTC). If not specified, the maintenance window will repeat indefinitely.Usage:Use cases: Limited-time maintenance periods, project-based scheduling, planned end dates.
Examples
Best Practices
Tag Matching: Maintenance windows affect ALL checks that have ANY of the specified tags. Be specific with your tags to avoid affecting unintended checks.
Time Zones: Always use UTC timestamps for consistency across different time zones. Convert your local maintenance times to UTC.