Skip to main content
A monitor checks on its 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 from MONITOR_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.
A check starts at its time, or within about a minute of it. Checks of one monitor never overlap. When the last check is still running as the next one falls due, the due check is recorded as skipped_overlap and costs nothing.

Options

Send cron 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.
This real answer is cut. The check started 52 seconds later and was completed.
Read the result with 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.
Run a check on an active monitor. Resume a paused monitor first.

Pause and resume

Send status to PATCH /v1/monitor/{id}.
A paused monitor reads nothing and costs nothing, and its nextRunAt is null. This real answer is cut.
Send { "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.
Changing the schedule of a paused monitor keeps it paused. A paused monitor still counts toward your limit of 25 monitors and 1,000 pages. See Limits and errors.

When a monitor pauses itself

  • Your balance ran out. The monitor pauses, pausedReason is insufficientCredits, and a monitor.failed event 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 error and costs nothing for it. After 5 checks in a row that fail to read the same page, a monitor.failed event is sent once.
A check where every page failed for lack of balance is recorded as skipped_no_credits.

Limits and errors

Every 400 below has the code invalidRequest.