Create a heartbeat
POST /heartbeats/create
POST
/heartbeats/create
Dashboard-style create. For scripts and agents, /hb/auto/{slug} is usually better: it is idempotent, returns JSON with the UUID, and arms monitoring with its first ping.
Authorizations
Section titled “Authorizations ”Request Body required
Section titled “Request Body required ”object
name
required
string
Example
Nightly database backup interval_seconds
required
integer
Example
86400 interval_value
Display value paired with interval_window (e.g. 24).
integer
interval_window
string
grace_period_seconds
required
integer
Example
3600 grace_period_value
integer
grace_period_window
string
escalation_policy_uuid
Defaults to the account’s default escalation policy.
string
region
Metrics home region key. Defaults to the tenant’s home region; normally omit this.
string
Responses
Section titled “ Responses ”Created (plain-text acknowledgement).
Plan limit reached — upgrade to add more.
object
error
string
message
string
key
additional properties
any