Pause and resume a monitor Beta
POST /api/v1/monitors/{id}/pause
POST /api/v1/monitors/{id}/resume
A paused monitor isn't checked and doesn't send alerts. Its settings and history are kept. No body is needed.
Needs an X-API-Key header whose owner has permission to manage uptime monitors in the app. The call counts once against your daily quota. See Monitoring API: getting started for authentication, rate limits and errors.
Request
Response
200 · application/json
- { "id": "mon_79ce3cf9c4fa56e98af4", "active": false, "usage": { "used": 16, "dailyLimit": 100, "tier": "free" } }
/resume returns "active": true. Pausing a paused monitor, or resuming a running one, is fine and returns the same shape.
Errors
| Status | When |
|---|---|
401 | The API key is missing or invalid. |
403 | The key's owner doesn't have permission to manage uptime monitors, or the key isn't linked to a workspace. |
404 | No monitor with that id in your workspace. |
405 | The endpoint doesn't accept that method. |
429 | A rate limit or your daily quota was hit. Read Retry-After, in seconds. Writes are also limited to 30 a minute per key. |
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
- Bulk update: pause or resume many monitors at once
- Delete a monitor: remove it and its history
- List monitors: filter by active