Sign in

v2

latestOpenAPI 3.0.02026-07-261859071.2 MB
Maintenance windows

Update a maintenance window status update

Updates a status update for a status-page-visible maintenance window.

put/v1/maintenance-windows/{id}/maintenances/{maintenanceId}/updates/{updateId}

Path parameters

idinteger required
maintenanceIdstring required
updateIdstring required

Headers

x-checkly-accountstring

Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general

Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general

Request body

status'SCHEDULED' | 'IN_PROGRESS' | 'VERIFYING' | 'COMPLETED' | 'CANCELLED'

The lifecycle status of this update. Optional. When omitted, the stored status is preserved.

descriptionstring required

A description of the update.

Response

Successful

idstring required
maintenanceWindowIdnumber required
maintenanceIdstring required
statusstring required
descriptionstring required
notifySubscribersboolean required
created_atstring date required
previousStatusstring nullable
previousStartsAtstring date nullable
previousEndsAtstring date nullable