v1

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-19273210655.1 KB

Sites

Create heartbeat

Create a new heartbeat for the site.

Processing mode: <small><code>sync</code></small>

post/orgs/{organization}/servers/{server}/sites/{site}/heartbeats

organizationstring required

The organization slug

serverinteger required

The server ID

siteinteger required

The site ID

namestring required

The name of the heartbeat.

grace_period1 | 2 | 5 | 10 | 30 | 60 required

frequency1 | 5 | 10 | 30 | 60 | 1440 | 10080 | 312480 | -1 required

custom_frequencystring

A cron expression representing the custom frequency at which the client is expected to send a ping, if the frequency is set to -1.

{
  "name": "My Heartbeat",
  "custom_frequency": "* * * * *"
}

HeartbeatResource