List maintenance windows Beta
GET /api/v1/maintenance
Returns your workspace's maintenance windows, newest first by start time.
Needs an X-API-Key header whose owner has access to uptime monitoring in the app. The call counts once against your daily quota. See Monitoring API: getting started for authentication, rate limits and errors.
Query parameters
| Name | Type | Description |
|---|---|---|
status optional | string | active (an occurrence is running now), upcoming (has a future occurrence, none running) or past (no occurrences left). |
monitorId optional | string | Only windows that cover this monitor, including allMonitors windows. |
page optional | integer | Page number, starting at 1. Default 1. |
per optional | integer | Windows per page, 1 to 1000. Default 100. |
Request
Response
200 · application/json
- {
- "total": 1, "page": 1, "per": 100,
- "windows": [
- { "id": "mw_3f9a0c1d2e4b5a6c7d8e", "description": "Weekly database backup", "recurrence": "week", "active": false, … }
- ],
- "usage": { "used": 30, "dailyLimit": 100, "tier": "free" }
- }
Errors
| Status | When |
|---|---|
400 | status isn't active, upcoming or past. |
401 | The API key is missing or invalid. |
403 | The key's owner doesn't have access to uptime monitoring, or the key isn't linked to a workspace. |
405 | The endpoint doesn't accept that method. |
429 | A rate limit or your daily quota was hit. Read Retry-After, in seconds. |
500 | Something went wrong on our side. Try again. |
503 | The API is temporarily unavailable. Try again shortly. |
Errors are JSON: { "error": "message" }. See Monitoring API errors.
Related
- Maintenance windows: how maintenance works and the window object
- Create a window: schedule new work
- List occurrences: when each window happens