Maintenance Windows

Maintenance windows notify users about planned downtime and exclude affected monitors from alerting.

List Maintenance Windows

GET/api/v1/maintenanceFree

curl https://unstatus.app/api/v1/maintenance \
  -H "Authorization: Bearer usk_your_key"

Get Maintenance Window

GET/api/v1/maintenance/:idFree

Create Maintenance Window

POST/api/v1/maintenanceAuthenticated

Sends notifications to configured channels when created.

Field	Type	Required	Description
`title`	string	Yes	Maintenance title
`description`	string	No	Description
`scheduledStart`	string	Yes	ISO 8601 start time
`scheduledEnd`	string	Yes	ISO 8601 end time
`monitorIds`	string[]	Yes	Affected monitor IDs

curl -X POST https://unstatus.app/api/v1/maintenance \
  -H "Authorization: Bearer usk_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Database migration",
    "description": "Upgrading to PostgreSQL 17",
    "scheduledStart": "2025-02-01T02:00:00Z",
    "scheduledEnd": "2025-02-01T04:00:00Z",
    "monitorIds": ["clx1abc..."]
  }'

Update Maintenance Window

PATCH/api/v1/maintenance/:idAuthenticated

Only scheduled windows can be edited.

Delete Maintenance Window

DELETE/api/v1/maintenance/:idAuthenticated

Only scheduled windows can be deleted.

Start Maintenance

POST/api/v1/maintenance/:id/startAuthenticated

Moves a scheduled window to in_progress. Sends notifications.

Complete Maintenance

POST/api/v1/maintenance/:id/completeAuthenticated

Marks an in-progress window as completed. Sends notifications.

Cancel Maintenance

POST/api/v1/maintenance/:id/cancelAuthenticated

Cancels a scheduled window. Only scheduled windows can be cancelled.

On this page