Sign in

v2

latestOpenAPI 3.0.02026-07-261859071.2 MB
Maintenance windows

Create a maintenance window status update

Creates a new status update for a status-page-visible maintenance window.

post/v1/maintenance-windows/{id}/maintenances/{maintenanceId}/updates

Path parameters

idinteger required
maintenanceIdstring 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' required

The lifecycle status of this update.

descriptionstring required

A description of the update.

notifySubscribersboolean

Whether to notify status page subscribers about this update.

Response

Created

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