Skip to main content

Maintenance Windows API

The Maintenance Windows API allows you to schedule periods where alerts and incident creation are suppressed for specific scopes (Global, Metric, Service, or CI).

List Maintenance Windows​

GET /api/maintenance-windows

Returns a list of up to the 500 most recent maintenance windows, ordered by start time.

Schedule Maintenance Window​

POST /api/maintenance-windows

Schedules a new maintenance window.

Body Parameters:

  • scopeType (String): The scope of the maintenance window. Must be Global, Metric, Service, or CI.
  • scopeNodeId (Integer, Optional): Required if scopeType is Service or CI. The ID of the topology node.
  • metricId (String, Optional): Required if scopeType is Metric. The unique key of the metric.
  • startTime (DateTime): The start time of the maintenance window (ISO-8601).
  • endTime (DateTime): The end time of the maintenance window (ISO-8601). Must be after startTime.
  • reason (String): The reason for the maintenance window.

Delete Maintenance Window​

DELETE /api/maintenance-windows/{id}

Deletes an existing maintenance window by its ID.