Skip to main content
POST
Create heartbeat

Authorizations

Authorization
string
header
required

API key sent as Authorization: Bearer <key>. Personal keys (gm_pat_) act as you, limited by your role and the key's scopes; organization keys (gm_api_) act for one organization. Send X-Organization-Id with every org-scoped request.

Headers

X-Organization-Id
string
required

ID of the organization to act in. Required with API keys. A user session may omit it and acts in its active organization.

Example:

"k2p9x7w4m1n8b3v6c5z0q2r7"

Body

application/json
name
string
required

Display name.

Required string length: 1 - 255
Example:

"Nightly backup"

intervalSeconds
integer
required

Expected time between pings, in seconds (1 minute to 7 days).

Required range: 60 <= x <= 604800
Example:

3600

gracePeriodSeconds
integer
required

Extra time allowed after the interval before the heartbeat is marked down.

Required range: 0 <= x <= 3600
Example:

300

description
string

Optional description.

Maximum string length: 1000

Response

Created

id
string
required
organizationId
string
required
userId
string
required
name
string
required
isActive
boolean
required
currentStatus
string
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
description
string
required
intervalSeconds
integer
required
gracePeriodSeconds
integer
required
token
string
required
heartbeatStatus
string
required
lastPingAt
string | null
required
lastPingStatus
string | null
required
pausedUntil
string | null
required