Maintenance Windows (Admin)

Engineer or admin CRUD for scheduled maintenance windows. During a maintenance window, alert evaluation is suppressed for entities within the window's hierarchical scope.

Create Maintenance Window

POST /api/v1/maintenance-windows

Creates a new maintenance window.

Request body:

{
  "name": "Router Upgrade - Building A",
  "description": "Firmware upgrade for core routers",
  "scope_type": "area",
  "scope_id": "uuid",
  "start_time": "2026-02-25T02:00:00Z",
  "end_time": "2026-02-25T06:00:00Z",
  "recurring": false,
  "recurrence": null
}

scope_type values: global, network, routing_domain, protocol_instance, area, device. For global scope, scope_id should be omitted or null.

Response: 201 Created

{
  "id": "uuid",
  "name": "Router Upgrade - Building A",
  "description": "Firmware upgrade for core routers",
  "scope_type": "area",
  "scope_id": "uuid",
  "start_time": "2026-02-25T02:00:00Z",
  "end_time": "2026-02-25T06:00:00Z",
  "recurring": false,
  "recurrence": null,
  "created_by": "uuid",
  "created_at": "2026-02-24T10:00:00Z",
  "updated_at": "2026-02-24T10:00:00Z"
}

Error responses:

400 Bad Request -- Missing required fields, invalid scope_type, or end_time not after start_time
401 Unauthorized -- Missing or invalid access token
403 Forbidden -- Non-admin user

List Maintenance Windows

GET /api/v1/maintenance-windows

List all maintenance windows.

Response: 200 OK

[
  {
    "id": "uuid",
    "name": "Router Upgrade - Building A",
    "description": "Firmware upgrade for core routers",
    "scope_type": "area",
    "scope_id": "uuid",
    "start_time": "2026-02-25T02:00:00Z",
    "end_time": "2026-02-25T06:00:00Z",
    "recurring": false,
    "recurrence": null,
    "created_by": "uuid",
    "created_at": "2026-02-24T10:00:00Z",
    "updated_at": "2026-02-24T10:00:00Z"
  }
]

Error responses:

401 Unauthorized -- Missing or invalid access token
403 Forbidden -- Non-admin user

Get Maintenance Window

GET /api/v1/maintenance-windows/{windowID}

Get a single maintenance window by ID.

Response: 200 OK (single maintenance window object)

Error responses:

401 Unauthorized -- Missing or invalid access token
403 Forbidden -- Non-admin user
404 Not Found -- Window does not exist

Update Maintenance Window

PUT /api/v1/maintenance-windows/{windowID}

Update a maintenance window.

Request body:

{
  "name": "Router Upgrade - Building A (extended)",
  "description": "Firmware upgrade for core routers - extended window",
  "scope_type": "area",
  "scope_id": "uuid",
  "start_time": "2026-02-25T02:00:00Z",
  "end_time": "2026-02-25T08:00:00Z",
  "recurring": false,
  "recurrence": null
}

Response: 200 OK (updated maintenance window object)

Error responses:

400 Bad Request -- Missing required fields, invalid scope_type, or end_time not after start_time
401 Unauthorized -- Missing or invalid access token
403 Forbidden -- Non-admin user
404 Not Found -- Window does not exist

Delete Maintenance Window

DELETE /api/v1/maintenance-windows/{windowID}

Delete a maintenance window.

Response: 204 No Content

Error responses:

401 Unauthorized -- Missing or invalid access token
403 Forbidden -- Non-admin user
404 Not Found -- Window does not exist