Better Uptime
What is Better Uptime?
System Status
Search…
Getting started
Frequently Asked Questions
🔭
Monitoring
Getting started
Working with monitors
Customizing monitors
Monitor types
📯
On-call scheduling and alering
Creating on-call rotation schedules
How on-call schedules work
Escalation policies
Urgencies
☎
Incidents
Working with incidents
Creating incidents manually
Postmortems
🖼
Status pages
Custom sub-domain: status.yourdomain.com
Working with status pages
Customizing status pages
⚙
Team and account management
Team management
Account settings
📟
API
Getting started
Monitors API
Escalation Policies API
Monitor Groups API
Heartbeats API
Heartbeat Groups API
Incidents API
Status Pages API
Status Page Sections API
Status Page Resources API
Status Page Reports API
Status Page Report Updates API
Metadata API
On-call Calendar API
🔗
Integrations
Slack
Zapier
Microsoft Teams
Webhooks
Google Cloud
AWS
New Relic
Prometheus
Zabbix
Grafana
Datadog
Powered By
GitBook
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
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!
API - Previous
Heartbeats API
Next - API
Incidents API
Last modified
1yr ago
Copy link
Contents
Obtaining an API token
get
Listing all existing heartbeat groups
get
Getting a single heartbeat group
post
Creating a new heartbeat group
patch
Updating an existing heartbeat group
delete
Deleting an existing heartbeat group