🔧
API
Heartbeats API
Manage your heartbeats using simple HTTP API.
Do you need help with the integration?
Obtaining an API token
get
https://betteruptime.com
/api/v2/heartbeats
Listing all existing heartbeats
Example cURL
1
curl --request GET \
2
--url https://betteruptime.com/api/v2/heartbeats \
3
--header 'Authorization: Bearer YOUR_API_TOKEN'
Copied!
get
https://betteruptime.com
/api/v2/heartbeats/:heartbeat_id
Getting a single heartbeat
Example cURL
1
curl --request GET \
2
--url https://betteruptime.com/api/v2/heartbeats/12345 \
3
--header 'Authorization: Bearer YOUR_API_TOKEN'
Copied!
post
https://betteruptime.com
/api/v2/heartbeats
Creating a heartbeat
Example cURL
1
curl --request POST \
2
--url https://betteruptime.com/api/v2/heartbeats \
3
--header 'Authorization: Bearer YOUR_API_TOKEN' \
4
--header 'Content-Type: application/json' \
5
--data '{
6
"name": "Testing heartbeat",
7
"period": 10800,
8
"grace": 300
9
}'
Copied!
patch
https://betteruptime.com
/api/v2/heartbeats/:heartbeat_id
Updating an existing endpoint
Example cURL
1
curl --request PATCH \
2
--url https://betteruptime.com/api/v2/heartbeats/12345 \
3
--header 'Authorization: Bearer YOUR_API_TOKEN' \
4
--header 'Content-Type: application/json' \
5
--data '{
6
"name": "Testing heartbeat, with an update"
7
}'
Copied!
delete
https://betteruptime.com
/api/v2/heartbeats/:heartbeat_id
Deleting an existing heartbeat
Example cURL
1
curl --request DELETE \
2
--url https://betteruptime.com/api/v2/heartbeats/12345 \
3
--header 'Authorization: Bearer YOUR_API_TOKEN'
Copied!
Last modified 7mo ago