Update a monitor Beta
PATCH /api/v1/monitors/{id}
Send only the settings you want to change. Everything you leave out keeps its current value. PUT to the same path does exactly the same thing.
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.
- Changing
urlresets the monitor's status and runs a new first check. The response then hasurlChanged: true. - Changing
typeis allowed. Send the settings the new type needs in the same request, such as aportfortcp, and a host rather than a URL. See Check types. - To keep the stored password, leave out
authPassword. Send""to remove it. - Leaving out
recipients,contacts,teamsortagskeeps them. Sending a list replaces that one. - To pause or resume, use pause and resume.
Request
Response
200 · application/json
- {
- "monitor": { "id": "mon_79ce3cf9c4fa56e98af4", "intervalMinutes": 30, "importance": "low", "tags": ["staging"], … },
- "urlChanged": false,
- "usage": { "used": 15, "dailyLimit": 100, "tier": "free" }
- }
Errors
| Status | When |
|---|---|
400 | A setting isn't valid (the message says which), the body isn't valid JSON, or a new URL is a private, local or blocked address. |
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. |
409 | The new URL is already monitored in your workspace. |
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
- Monitor settings: every setting and its allowed values
- Pause and resume: stop checks without deleting
- Bulk update: change many monitors at once