Supercheck LogoSupercheck
Monitors API

Report a heartbeat run start or failure

GET
/api/heartbeat/{token}/{action}

Public endpoint called by your job when it finishes. No authentication: the token in the URL identifies the monitor. GET, POST and HEAD are accepted; the body is ignored. See /docs/app/heartbeat.

Path Parameters

token*string

The token from the ping URL.

Match^hb_[0-9a-f]{32}$
action*string

start records that a run began (the next ping reports its duration); fail marks the monitor down at once.

Value in"start""fail"

Response Body

Always OK (text/plain, Cache-Control: no-store), whether or not the token matched a monitor.

response?stringtext/plain
Example Request
curl -X GET 'https://app.supercheck.io/api/heartbeat/string/start'
Example Response
"string"