Heartbeat Groups API

Manage your heartbeat groups using a simple HTTP 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/heartbeat-groups
Listing all existing heartbeat groups
Example cURL
curl --request GET \
  --url https://betteruptime.com/api/v2/heartbeat-groups \
  --header 'Authorization: Bearer YOUR_API_TOKEN'
get
https://betteruptime.com
/api/v2/heartbeat-groups/:heartbeat_group_id
Getting a single heartbeat group
Example cURL
curl --request GET \
  --url https://betteruptime.com/api/v2/heartbeat-groups/123456 \
  --header 'Authorization: Bearer YOUR_API_TOKEN'
post
https://betteruptime.com
/api/v2/heartbeat-groups
Creating a new heartbeat group
Example cURL
curl --request POST \
  --url https://betteruptime.com/api/v2/heartbeat-groups \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
	"name": "Backend services"
}'
patch
https://betteruptime.com
/api/v2/heartbeat-groups/:heartbeat_group_id
Updating an existing heartbeat group
Example cURL — Change name only
curl --request PATCH \
  --url https://betteruptime.com/api/v2/heartbeat-groups/95251342 \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
	"name": "Backend services 2"
}'
delete
https://betteruptime.com
/api/v2/heartbeat-groups/:heartbeat_group_id
Deleting an existing heartbeat group
Example cURL
curl --request DELETE \
  --url https://betteruptime.com/api/v2/heartbeat-groups/95251342 \
  --header 'Authorization: Bearer YOUR_API_TOKEN'

API - Previous

Heartbeats API

Next - API

Incidents API

Last modified 1yr ago