Maintenance API

Scheduled maintenance windows. This page lists all 6 endpoints in the Maintenance area of the Visual Sentinel REST API.

Base URL: https://visualsentinel.com. Unless an endpoint says otherwise it accepts an API key or a session cookie, see Authentication. Most error responses use the ErrorResponse shape, see Errors and Rate limits.

Endpoints

List maintenance windows: GET /api/maintenance
Create maintenance window: POST /api/maintenance
Get maintenance window: GET /api/maintenance/{id}
Update maintenance window: PATCH /api/maintenance/{id}
Delete maintenance window: DELETE /api/maintenance/{id}
Cancel maintenance window: POST /api/maintenance/{id}/cancel

List maintenance windows

GET /api/maintenance

List maintenance windows that occur between from and to (default: 90 days ago to about a year ahead).

Parameters

from (query, string (date-time), optional)
to (query, string (date-time), optional)
status (query, string, optional): One of: scheduled, in-progress, completed, cancelled.

Responses

200: Maintenance windows. Body: object.
400: Invalid from or to.

Field	Type	Required	Description
`maintenanceWindows`	array of MaintenanceWindow	No

Create maintenance window

POST /api/maintenance

Schedule a maintenance window. Alerts for the linked monitors are suppressed while it is active, and status pages show it.

Request body (required): CreateMaintenanceWindowRequest.

Responses

200: Maintenance window created. Body: object.
400: title, startTime or endTime missing or invalid, end not after start, longer than 90 days, or an unknown recurrenceKind.
403: Read-only role or an API key without maintenance:write.

Field	Type	Required	Description
`maintenanceWindow`	MaintenanceWindow	No
`message`	string	No

Get maintenance window

GET /api/maintenance/{id}

Get details of a specific maintenance window.

Parameters

id (path, string (uuid), required)

Responses

200: Maintenance window details.

Update maintenance window

PATCH /api/maintenance/{id}

Update a maintenance window. Send only the fields that change.

Parameters

id (path, string (uuid), required)

Request body (required): UpdateMaintenanceWindowRequest.

Responses

200: Maintenance window updated. Body: object.
400: Invalid dates, end not after start, longer than 90 days, or an unknown recurrenceKind.
404: Maintenance window not found.

Field	Type	Required
`maintenanceWindow`	object	No
`maintenanceWindow.id`	string (uuid)	No
`maintenanceWindow.title`	string	No
`message`	string	No

Delete maintenance window

DELETE /api/maintenance/{id}

Delete a maintenance window.

Parameters

id (path, string (uuid), required)

Responses

200: Maintenance window deleted.

Cancel maintenance window

POST /api/maintenance/{id}/cancel

Cancel a window. For a repeating window, action: "skip-next" skips one occurrence (the next one, or occurrence) and action: "stop-repeating" turns it into a one-off; without an action the whole window is cancelled.

Parameters

id (path, string (uuid), required)

Request body (optional): object.

Field	Type	Required	Description
`action`	string	No	One of: `skip-next`, `stop-repeating`.
`occurrence`	string (date-time)	No	With `skip-next`: the future occurrence start to skip.

Responses

200: Done. Body: object.
400: No next occurrence to skip.
404: Maintenance window not found.

Field	Type	Required	Description
`ok`	boolean	No

Data models

Request and response shapes these endpoints use: MaintenanceWindow, CreateMaintenanceWindowRequest, UpdateMaintenanceWindowRequest.

Generated from the OpenAPI 3.1 specification at https://docs.visualsentinel.com/openapi.json, the same file the interactive reference reads.