maintenance_windows

PATCH /api/maintenance_windows/{key}

Request

  • Base URL
    https://cronitor.io
  • Auth
    HTTP basic

Path parameters

keystring required

Headers

Cronitor-Version'2025-11-28' | '2020-10-01'

API version. These schemas describe 2025-11-28. Requests without the header get 2020-10-01. https://cronitor.io/docs/api#versioning

Request body

namestring
descriptionstring nullable
startstring date-time
endstring date-time
affects_all_monitorsboolean
affects_statuspage_componentsboolean
environmentstring nullable

Environment key.

statuspagesstring[]

Status page keys.

Response

keystring required
namestring required
descriptionstring nullable
startstring date-time required
endstring date-time required
affects_all_monitorsboolean
affects_statuspage_componentsboolean
environmentstring nullable

Environment key.

statuspagesstring[]

Status page keys.

all_affected_monitorsstring required
durationinteger required

Returns the total duration of the maintenance window in seconds.

statestring required

Returns whether the window is currently past|ongoing|upcoming.

createdstring date-time required
updatedstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.