Sign in

v3

latestOpenAPI 3.0.02026-07-2759120262.8 KB
Maintenance Windows

Create a maintenance window

Create a maintenance window

post/maintenance-windows

Request body

namestring required

Friendly name of the maintenance window

autoAddMonitorsboolean

If true, all monitors are automatically added to this maintenance window

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

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

timestring required

Start time of the maintenance window in HH:mm:ss format

durationnumber required

Duration of the maintenance window in minutes. Maintenance window will be active for this duration

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[]

List of monitor IDs to be assigned to the maintenance window

Example request

{
  "name": "Friday Maintenance window",
  "date": "2024-06-20",
  "time": "14:30:00",
  "duration": 30,
  "days": [
    2,
    4,
    5
  ],
  "monitorIds": [
    1,
    2,
    3
  ]
}

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