Sign in

v3

latestOpenAPI 3.0.02026-07-2759120262.8 KB
Maintenance Windows

Update a maintenance window

Update a maintenance window

patch/maintenance-windows/{id}

Path parameters

idnumber required

ID of the maintenance window

Request body

namestring

Name of the maintenance window

interval'once' | 'daily' | 'weekly' | 'monthly'
datestring

Start date of the maintenance window in YYYY-MM-DD format (years 19xx or 20xx only)

timestring

Time format in HH:mm:ss

durationnumber

Duration in minutes

daysnumber[]

(only needed for weekly and monthly maintenance windows). E.g. [2, 4, 5] for Tuesday, Thursday and Friday or [10, 17, 26] for the days of the month. -1 for last day of the month)

monitorIdsnumber[]

Array of monitor IDs to associate with this maintenance window

status'active' | 'paused'

Pause or resume the maintenance window. paused stops it from suppressing alerts; active re-enables it. Omit to leave the current status unchanged.

Example request

{
  "name": "Weekend Maintenance Window",
  "date": "2024-06-20",
  "time": "12:00:00",
  "duration": 10,
  "days": [
    2,
    4,
    5
  ],
  "monitorIds": [
    1,
    2,
    3
  ],
  "status": "active"
}

Response

idnumber required
userIdnumber required
namestring required
interval'once' | 'daily' | 'weekly' | 'monthly' required
datestring nullable required
timestring required
durationnumber required
autoAddMonitorsboolean required
monitorIdsnumber[] required
daysnumber[] required
status'active' | 'paused' required