Skip to main content
GET
Get a monitor

Overview

Returns the monitor exactly as it runs: every target with its effective options, the schedule as cron, the next run, the webhook — including its signing secret — and the summary of the most recent check. A monitor you do not own returns 404 rather than 403. Monitor ids are unguessable, and confirming that some id exists is the only thing an enumeration attempt is after.

Example request

Reading the monitor

For a monitor’s history, list its checks with GET /monitor/{id}/checks.

PATCH /monitor/{id}

Change it, pause it or resume it.

GET /monitor/{id}/checks

Its check history.

Authorizations

X-API-Key
string
header
required

Your Prefetch API key. Obtain one from the dashboard.

Path Parameters

id
string
required

The monitor id returned by POST /monitor.

Example:

"mon_3f9a1c2b7d4e4f6a8b0c1d2e3f4a5b6c"

Response

Monitor.

success
enum<boolean>
required
Available options:
true
data
object
required
meta
object
required