GET
https://uptime.betterstack.com/api/v2/heartbeats
Headers
Authorization
required
string
Bearer $TOKEN
Explore documentation
List all existing heartbeats
Returns a list of all your heartbeats. This endpoint supports pagination.
200
The status attribute can have one of the following values:
paused - the heartbeat was paused
pending - the heartbeat was just created and is waiting for the first request
up - heartbeat received request on time
down - heartbeat did not receive a request on time
Response body
{
"data": [
{
"id": "12345",
"type": "heartbeat",
"attributes": {
"url": "https://uptime.betterstack.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,
"team_name": "Test team",
"sort_index": null,
"paused_at": null,
"maintenance_from": "01:02:00",
"maintenance_to": "03:04:00",
"maintenance_timezone": "Amsterdam",
"maintenance_days": [
"mon",
"tue",
"wed",
"thu",
"fri",
"sat",
"sun"
],
"created_at": "2020-05-05T11:41:49.327Z",
"updated_at": "2020-12-10T14:40:23.436Z",
"status": "up"
}
}
],
"pagination": {
"first": "https://uptime.betterstack.com/api/v2/heartbeats?page=1",
"last": "https://uptime.betterstack.com/api/v2/heartbeats?page=1",
"prev": null,
"next": null
}
}Example cURL
Example
curl --request GET \
--url https://uptime.betterstack.com/api/v2/heartbeats \
--header "Authorization: Bearer $TOKEN"