Skip to content

Ping a heartbeat monitor (POST)

POST
/api/v1/heartbeat/{token}

Records a heartbeat ping for the monitor associated with the given token. Behaves identically to the GET variant. This endpoint does not require authentication.

token
required
string
Example
hb_a1b2c3d4e5f6

Unique heartbeat token assigned to a heartbeat monitor.

Heartbeat recorded successfully.

object
ok
required
boolean
Example
true
monitor_id
required
integer
Example
42

The requested resource was not found.

Error response returned when a request fails.

object
error
required

A human-readable error message.

string
Example
monitor not found
Example
{
"error": "not found"
}