コンテンツにスキップ

Start maintenance

POST
/api/v1/monitors/{id}/maintenance

Start a maintenance window for the specified duration. Checks continue but incident creation is suppressed.

id
required
string
object
maintenanceUntil
required

ISO 8601 end datetime for maintenance (max 7 days ahead)

string format: date-time
notify

Send notification to configured channels (requires notifications module)

boolean
autoResolve

When true, maintenance auto-resolves at the scheduled end time. When false, maintenance persists until manually ended.

boolean
default: true

Maintenance started

object
monitor
object
id
string
teamId
string
type
string
Allowed values: http tcp ping heartbeat webchange ssl domain
name
string
config

Type-specific configuration

object
intervalSeconds
integer
>= 60 <= 86400
status
string
Allowed values: up down degraded unknown paused
isActive
integer
Allowed values: 0 1
lastCheckedAt
string format: date-time
nullable
maintenanceUntil

ISO 8601 timestamp until which the monitor is under maintenance. Null when not in maintenance.

string format: date-time
nullable
autoResolveMaintenance

Whether maintenance auto-resolves (1) or requires manual resolution (0).

integer
Allowed values: 0 1
createdAt
string format: date-time
updatedAt
string format: date-time

Validation error

Monitor not found