Skip to main content
GET
/
v1
/
heartbeats
List heartbeats
curl --request GET \
  --url https://api.rootly.com/v1/heartbeats \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "type": "heartbeats",
      "attributes": {
        "name": "<string>",
        "alert_summary": "<string>",
        "interval": 123,
        "notification_target_id": "<string>",
        "enabled": true,
        "email_address": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>",
        "description": "<string>",
        "alert_description": "<string>",
        "alert_urgency_id": "<string>",
        "ping_url": "<string>",
        "secret": "<string>",
        "last_pinged_at": "<string>",
        "expires_at": "<string>"
      }
    }
  ],
  "links": {
    "self": "<string>",
    "first": "<string>",
    "prev": "<string>",
    "next": "<string>",
    "last": "<string>"
  },
  "meta": {
    "current_page": 123,
    "next_page": 123,
    "prev_page": 123,
    "total_count": 123,
    "total_pages": 123,
    "next_cursor": "<string>"
  },
  "included": [
    {
      "id": "<string>",
      "type": "<string>",
      "attributes": {},
      "relationships": {}
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
include
string
​
page[number]
integer
​
page[size]
integer
​
filter[search]
string
​
filter[slug]
string
​
filter[name]
string
​
filter[created_at][gt]
string
​
filter[created_at][gte]
string
​
filter[created_at][lt]
string
​
filter[created_at][lte]
string

Response

200 - application/vnd.api+json

filter by name

​
data
object[]
required
​
links
object
required
​
meta
object
required
​
included
object[]