schedule, from every 5 minutes up. You can also check now, and pause and resume a monitor without losing its history.
Change the schedule
Get an API key in the Quickstart. The samples read the monitor’s id fromMONITOR_ID. Send schedule when you create a monitor, or change it later with PATCH /v1/monitor/{id}. This request moves a monitor to 9:00 every day in Ljubljana.
Read the response
The call answers with the monitor.schedule holds the plain words as a cron expression. This real answer is cut to schedule. The next check of that monitor was due at 2026-11-18T08:00:00.000Z, which is 09:00 in Ljubljana.
skipped_overlap and costs nothing.
Options
Sendcron or text, not both.
The older
interval field takes seconds, or text such as 30m, 6h or 1d, from 5 minutes to 30 days. Use it only with the older url and urls fields.
Run a check now
POST /v1/monitor/{id}/run queues a check outside the schedule. It answers at once with the queued check, and its id is the check’s id. The schedule does not move. A check you run costs the same as a scheduled one.
completed.
GET /v1/monitor/{id}/checks/{checkId}. See Checks and changes.
A monitor runs one check at a time. While a check is queued or running, a second run returns 409 checkRunning.
Pause and resume
Sendstatus to PATCH /v1/monitor/{id}.
nextRunAt is null. This real answer is cut.
{ "status": "active" } to resume it. A resumed monitor checks again at once: nextRunAt was the moment of the call, and the check ran within a minute and cost $0.001.
When a monitor pauses itself
- Your balance ran out. The monitor pauses,
pausedReasonisinsufficientCredits, and amonitor.failedevent is sent if you subscribed to it. Add funds, then send{ "status": "active" }. - A page cannot be read. The monitor keeps running. The check shows the page as
errorand costs nothing for it. After 5 checks in a row that fail to read the same page, amonitor.failedevent is sent once.
skipped_no_credits.
Limits and errors
Every400 below has the code invalidRequest.
Related
- Targets sets what each check reads.
- Checks and changes reads what a check found.
- Webhooks sends an event after each check.