Skip to main content
POST
/
api
/
v1
/
heartbeats
Create a heartbeat monitor
curl --request POST \
  --url https://api.example.com/api/v1/heartbeats \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "intervalSeconds": 302430,
  "gracePeriodSeconds": 1800,
  "description": "<string>"
}
'

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
name
string
required
​
intervalSeconds
number
required

1 minute to 7 days in seconds

Required range: 60 <= x <= 604800
​
gracePeriodSeconds
number
required
Required range: 0 <= x <= 3600
​
description
string

Response

201 - undefined