Ping a heartbeat monitor (GET)

GET

/api/v1/heartbeat/{token}

• Production

Records a heartbeat ping for the monitor associated with the given token. This endpoint does not require authentication and is intended to be called from cron jobs, scripts, or other automated processes.

If the monitor has a heartbeat_secret configured, the request must include an X-Secret header with the matching value, otherwise returns 401.

Parameters

Path Parameters

token

required

string

Example

hb_a1b2c3d4e5f6

Unique heartbeat token assigned to a heartbeat monitor.

Header Parameters

X-Secret

string

Required if the heartbeat monitor has a secret configured.

Responses

200

Heartbeat recorded successfully.

object

ok

required

boolean

Example

true

monitor_id

required

integer

Example

42

401

Secret mismatch. The X-Secret header is missing or does not match.

404

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"
}