Bulk update monitors Beta
PATCH /api/v1/monitors
Pause, resume or change the check interval of many monitors in one call. The whole call counts once against your quota.
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.
Body
| Field | Type | Description |
|---|---|---|
ids required | string[] | Monitor ids, up to 500. Ids after the 500th are ignored. |
active optional | boolean | false to pause, true to resume. |
intervalMinutes optional | integer | New check interval. Same rules as the setting. |
Send at least one of active and intervalMinutes.
Request
Response
200 · application/json
- {
- "updated": ["mon_79ce3cf9c4fa56e98af4", "mon_4b1d0a7e2c9f83d56e10"],
- "notFound": ["mon_000000000000000000aa"],
- "usage": { "used": 18, "dailyLimit": 100, "tier": "free" }
- }
Ids that aren't in your workspace are listed in notFound and don't fail the call. Monitors are changed in order; if one fails for another reason (for example, an interval that's too short for its regions), the call stops with that error and monitors earlier in the list keep their change.
Errors
| Status | When |
|---|---|
400 | No ids, neither active nor intervalMinutes, an interval that isn't allowed, or a body that isn't valid JSON. |
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. |
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
- Update a monitor: change every setting of one monitor
- Bulk delete: delete many at once
- Pause and resume: one monitor at a time