🔧
API
Heartbeat Groups API
Manage your heartbeat groups using a simple HTTP API.
Do you need help with the integration?
Obtaining an API token
get
https://betteruptime.com
/api/v2/heartbeat-groups
Listing all existing heartbeat groups
Example cURL
1
curl --request GET \
2
--url https://betteruptime.com/api/v2/heartbeat-groups \
3
--header 'Authorization: Bearer YOUR_API_TOKEN'
Copied!
get
https://betteruptime.com
/api/v2/heartbeat-groups/:heartbeat_group_id
Getting a single heartbeat group
Example cURL
1
curl --request GET \
2
--url https://betteruptime.com/api/v2/heartbeat-groups/123456 \
3
--header 'Authorization: Bearer YOUR_API_TOKEN'
Copied!
post
https://betteruptime.com
/api/v2/heartbeat-groups
Creating a new heartbeat group
Example cURL
1
curl --request POST \
2
--url https://betteruptime.com/api/v2/heartbeat-groups \
3
--header 'Authorization: Bearer YOUR_API_TOKEN' \
4
--header 'Content-Type: application/json' \
5
--data '{
6
"name": "Backend services"
7
}'
Copied!
patch
https://betteruptime.com
/api/v2/heartbeat-groups/:heartbeat_group_id
Updating an existing heartbeat group
Example cURL — Change name only
1
curl --request PATCH \
2
--url https://betteruptime.com/api/v2/heartbeat-groups/95251342 \
3
--header 'Authorization: Bearer YOUR_API_TOKEN' \
4
--header 'Content-Type: application/json' \
5
--data '{
6
"name": "Backend services 2"
7
}'
Copied!
delete
https://betteruptime.com
/api/v2/heartbeat-groups/:heartbeat_group_id
Deleting an existing heartbeat group
Example cURL
1
curl --request DELETE \
2
--url https://betteruptime.com/api/v2/heartbeat-groups/95251342 \
3
--header 'Authorization: Bearer YOUR_API_TOKEN'
Copied!
Last modified 7mo ago