MaintenanceWindow data model
The MaintenanceWindow shape in the Visual Sentinel REST API.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | No | |
title | string | No | |
description | string | No | |
status | string | No | One of: scheduled, in-progress, completed, cancelled. |
startTime | string (date-time) | No | |
endTime | string (date-time) | No | |
duration | string | No | For example 1h 30m. |
affectedServices | array of string | No | Monitor names. |
affectedMonitorIds | array of string (uuid) | No | |
recurring | boolean | No | |
recurrenceRule | string or null | No | |
recurrenceKind | string | No | One of: none, day, week, month, custom. |
nextOccurrence | object or null | No | |
nextOccurrence.startsAt | string (date-time) | No | |
nextOccurrence.endsAt | string (date-time) | No | |
cancelledAt | string (date-time) or null (date-time) | No | |
skippedOccurrences | array of string (date-time) | No | |
timezone | string | No | |
createdAt | string (date-time) | No |
Used by
- List maintenance windows:
GET /api/maintenance - Create maintenance window:
POST /api/maintenance
Generated from the OpenAPI 3.1 specification at https://docs.visualsentinel.com/openapi.json.