Heartbeats API

Do you need help with the integration? 
Let us know at [email protected].
Obtaining an API token
Please, see Obtaining an API token.
get
https://betteruptime.com
/api/v2/heartbeats
Listing all existing heartbeats
Example cURL
curl --request GET \
  --url https://betteruptime.com/api/v2/heartbeats \
  --header 'Authorization: Bearer YOUR_API_TOKEN'
get
https://betteruptime.com
/api/v2/heartbeats/:heartbeat_id
Getting a single heartbeat
Example cURL
curl --request GET \
  --url https://betteruptime.com/api/v2/heartbeats/12345 \
  --header 'Authorization: Bearer YOUR_API_TOKEN'
post
https://betteruptime.com
/api/v2/heartbeats
Creating a heartbeat
Example cURL
curl --request POST \
  --url https://betteruptime.com/api/v2/heartbeats \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
	"name": "Testing heartbeat",
	"period": 10800,
	"grace": 300
}'
patch
https://betteruptime.com
/api/v2/heartbeats/:heartbeat_id
Updating an existing endpoint
Example cURL
curl --request PATCH \
  --url https://betteruptime.com/api/v2/heartbeats/12345 \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
	"name": "Testing heartbeat, with an update"
}'
delete
https://betteruptime.com
/api/v2/heartbeats/:heartbeat_id
Deleting an existing heartbeat
Example cURL
curl --request DELETE \
  --url https://betteruptime.com/api/v2/heartbeats/12345 \
  --header 'Authorization: Bearer YOUR_API_TOKEN'

API - Previous

Monitor Groups API

Next - API

Heartbeat Groups API

Last modified 6mo ago

Copy link

On this page

Obtaining an API token

get

Listing all existing heartbeats

get

Getting a single heartbeat

post

Creating a heartbeat

patch

Updating an existing endpoint

delete

Deleting an existing heartbeat