Skip to content

Ping a heartbeat with its scoped key

GET
/hb/ping/{uuid}

Record a ping using the heartbeat’s own key. This is the form to embed in cron jobs and scripts: the key can only ping this one heartbeat, so leaking it does not expose the account.

uuid
required
string

Ping recorded.

object
message
string
Example
pong
status
string
Example
ok

Heartbeat key is incorrect.

Not found.

object
error
string
message
string
key
additional properties
any