Get a heartbeat

GET

/heartbeats/{uuid}

• Production

One heartbeat by UUID, including its ping key. The key is what a job sends in X-Heartbeat-Key; fetch it here when you need to rotate a cron entry or wire a new script to an existing heartbeat without opening the dashboard.

Authorizations

• apiKey

Parameters

Path Parameters

uuid

required

string

Responses

200

The heartbeat, including its scoped ping key.

object

uuid

string

Example

d1nq8sg44a5g5h3k2b7g

slug

Set for heartbeats created through /hb/auto/{slug}; empty for heartbeats created in the dashboard.

string

Example

nightly-backup

name

string

Example

Nightly database backup

api_key

Scoped ping key for the X-Heartbeat-Key header.

string

Example

hb.2h9XkPq...

status

initial until the first ping arrives; ok while pings arrive on schedule; delayed when a ping is late but within grace; missed/critical as missed pings accumulate.

string

Allowed values: initial ok delayed missed critical failed disabled unknown

enabled

boolean

interval_seconds

Expected seconds between pings.

integer

Example

86400

grace_period_seconds

Seconds a ping may be late before it counts as missed.

integer

Example

3600

escalation_policy_uuid

string

last_ping

Unix milliseconds of the last received ping.

integer format: int64

next_expected_ping

Unix milliseconds by which the next ping is expected.

integer format: int64

missed_pings

integer

successful_pings

integer

health_score

0-100 health score derived from recent ping history.

integer

created_at

string format: date-time

key

additional properties

any

404

Not found.

object

error

string

message

string

key

additional properties

any