Run a test monitor now

POST

/api/v1/monitors/{id}/run

Docs menu

Test mode only. Runs the monitor once at once, so you can see a change without waiting for a schedule. Answers 202 with the check the run made, queued. A live key gets test_only_endpoint.

Key
Bearer key, test or live
Scope
monitors:write
Idempotency
Header recommended

Parameters

idstringrequired

The id of the monitor.

Headers

Idempotency-Keystringoptional

Makes a retry safe: the same key with the same request returns the first answer. See Idempotency.

Response

202. The check the run made, queued.

idstring

chk_...

objectstring

check

livemodeboolean
statusstring

queuedrunningcompletedfailedcanceled

modestring

textlink_check

kindstring

checkrecheck

sourcestring

apiconsolemonitor

monitor_idstring or null
client_domainstring
page_countinteger
project_idstring or null

The client project it is tagged to, in the same workspace; null when none.

pagesarray of object

Empty until the check has completed.

Show child fields
objectstring

page_result

positioninteger

0-based, in the order you sent the pages.

urlstring

The address you sent.

verdictstring or null

null only when the check failed before this page ran.

VERIFIED_LIVELIVE_NO_FINGERPRINTNOT_LIVEUNVERIFIABLELINK_LIVELIVE_NO_LINK

fetched_atstring or null

When we fetched the page (UTC). This is the age of the result.

reusedboolean

True when the result comes from a fetch made in the last 15 minutes.

final_urltext or unknown
http_statusnumber or unknown
registrable_domaintext or unknown
textobject
linksobject
disclosureobject
noindexyes/no or unknown
canonical_urltext, null or unknown
published_attext, null or unknown
unknownsarray of object

Every unknown above, by dotted field name.

chargedboolean

Whether this page was billed.

rejectedarray of object

Addresses refused at submission. Never charged.

Show child fields
inputstring
codestring

See page rejection codes on the Errors page.

summaryobject or null
creditsobject
Show child fields
heldinteger
chargedinteger or null
free_pagesinteger
failure_codestring or null
metadataobject

Your own notes: up to 20 keys, each key up to 40 characters, each value up to 500.

created_atstring
started_atstring or null
completed_atstring or null

Errors

CodeStatusMeaning
missing_scope403The API key does not have the scope this endpoint needs.
test_only_endpoint403This endpoint works with test keys only.
not_found404No such object.
monitor_not_active409The monitor is not active.
monitor_ended409The monitor has ended.

Any request can also fail with missing_api_key, invalid_api_key, api_key_revoked, rate_limited or internal_error. See Errors.

In test mode