Let us know at hello@betteruptime.com.
Please, see Obtaining an API token.
YOUR_API_TOKEN
{"data": [{"id": "12345","type": "heartbeat","attributes": {"url": "https://betteruptime.com/api/v1/heartbeat/abcd1234abcd1234abcd1234","name": "Testing heartbeat","period": 10800,"grace": 300,"call": false,"sms": false,"email": true,"push": true,"team_wait": 180,"heartbeat_group_id": null,"sort_index": null,"paused_at": null,"created_at": "2020-05-05T11:41:49.327Z","updated_at": "2020-12-10T14:40:23.436Z"}}],"pagination": {"first": "https://betteruptime.com/api/v2/heartbeats?page=1","last": "https://betteruptime.com/api/v2/heartbeats?page=1","prev": null,"next": null}}
curl --request GET \--url https://betteruptime.com/api/v2/heartbeats \--header 'Authorization: Bearer YOUR_API_TOKEN'
YOUR_API_TOKEN
{"data": {"id": "12345","type": "heartbeat","attributes": {"url": "https://betteruptime.com/api/v1/heartbeat/abcd1234abcd1234abcd1234","name": "Testing heartbeat","period": 10800,"grace": 300,"call": false,"sms": false,"email": true,"push": true,"team_wait": 180,"heartbeat_group_id": null,"sort_index": null,"paused_at": null,"created_at": "2020-05-05T11:41:49.327Z","updated_at": "2020-12-10T15:00:15.089Z"}}}
curl --request GET \--url https://betteruptime.com/api/v2/heartbeats/12345 \--header 'Authorization: Bearer YOUR_API_TOKEN'
YOUR_API_TOKEN
30
seconds0
seconds
We recommend setting this to approx. 20% of period
true
to pause monitoring — we won't notify you about downtime.
Set to false
to resume monitoring{"data": {"id": "12345","type": "heartbeat","attributes": {"url": "https://betteruptime.com/api/v1/heartbeat/abcd1234abcd1234abcd1234","name": "Testing heartbeat","period": 10800,"grace": 300,"call": false,"sms": false,"email": true,"push": true,"team_wait": 180,"heartbeat_group_id": null,"sort_index": null,"paused_at": null,"created_at": "2020-05-05T11:41:49.327Z","updated_at": "2020-12-10T15:00:15.089Z"}}}
{"errors": {"name": ["Can't be blank."]}}
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}'
name
)YOUR_API_TOKEN
30
seconds0
seconds
We recommend setting this to approx. 20% of period
true
to pause monitoring — we won't notify you about downtime.
Set to false
to resume monitoring{"data": {"id": "12345","type": "heartbeat","attributes": {"url": "https://betteruptime.com/api/v1/heartbeat/abcd1234abcd1234abcd1234","name": "Testing heartbeat, with an update","period": 10800,"grace": 300,"call": false,"sms": false,"email": true,"push": true,"team_wait": 180,"heartbeat_group_id": null,"sort_index": null,"paused_at": null,"created_at": "2020-05-05T11:41:49.327Z","updated_at": "2020-12-10T15:00:15.089Z"}}}
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"}'
YOUR_API_TOKEN
curl --request DELETE \--url https://betteruptime.com/api/v2/heartbeats/12345 \--header 'Authorization: Bearer YOUR_API_TOKEN'