Explore documentation
  1. Welcome to Uptime 👋
  2. Frequently Asked Questions
  3. Monitoring
    1. Get started with monitoring
    2. Working with monitors
    3. Customizing monitors
    4. Monitor types
  4. On-call scheduling and alerting
    1. Get started with on-call
    2. Sending alerts to Slack ↗
    3. Connecting external calendars
    4. Advanced on-call setup
  5. Incidents
    1. Working with incidents
    2. Create incidents manually
    3. Post mortems
    4. Incident silencing
    5. Incident metadata
  6. Status pages
    1. Get started with status pages
    2. Working with status pages
  7. Integrations
    1. Integrating with Better Stack
  8. Team and account management
    1. Team management
    2. Account settings
    3. Audit logs
  9. API
    1. Get started with API
  10. Monitors API
    1. Monitors
    2. Monitor groups
    3. Heartbeats
      1. List all existing heartbeats GET
      2. Get a single heartbeat GET
      3. Create a heartbeat POST
      4. Update existing heartbeat PATCH
      5. Delete existing heartbeat DELETE
      6. Heartbeats API response params
    4. Heartbeat groups
  11. On-call & Incidents API
    1. On-call calendar
    2. Escalation policies
    3. Severities
    4. Incidents
    5. Comments
  12. Integrations API
    1. New Relic Integrations
    2. Datadog Integrations
    3. AWS CloudWatch Integrations
    4. Azure Integrations
    5. Google Monitoring Integrations
    6. Grafana Integrations
    7. Prometheus Integrations
    8. Email integrations
    9. Incoming webhooks
    10. Splunk On-Call integrations
    11. PagerDuty Integrations
  13. Status pages API
    1. Status pages
    2. Status page sections
    3. Status page resources
    4. Status page reports
    5. Status page report updates
  14. Other API
    1. Metadata

Heartbeats API response params

Response body params

Namespace data

Parameter Type Values
id String The ID of the heartbeat
type String heartbeat
attributes Object Attributes object (see below)
attributes.url String URL to your heartbeat
attributes.name String A name of the service for this heartbeat
attributes.period Integer How often should we expect this heartbeat? In seconds Minimum value: 30 seconds
attributes.grace Integer Heartbeats can fluctuate; specify this value to control what is still acceptable Minimum value: 0 seconds We recommend setting this to approx. 20% of period
attributes.call Boolean Should we call the on-call person?
attributes.sms Boolean Should we send an SMS to the on-call person?
attributes.email Boolean Should we send an email to the on-call person?
attributes.push Boolean Should we send a push notification to the on-call person?
attributes.team_wait Integer How long should we wait before escalating the incident alert to the team? Leave blank to disable escalating to the entire team.
attributes.heartbeat_group_id String Set this attribute if you want to add this heartbeat to a heartbeat group. Can be null
attributes.sort_index Integer An index controlling the position of a heartbeat in the heartbeat group.
attributes.paused_at String (ISO DateTime format) When was the heartbeat paused. Can be null if heart beat is not paused.
attributes.created_at String (ISO DateTime format) When was the heartbeat created. Example value "2020-05-05T11:41:49.327Z"
attributes.updated_at String (ISO DateTime format) When was the heartbeat last updated. Example value "2020-05-05T11:41:49.327Z"
attributes.status String 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 first request - up - heartbeat received request on time - down - heartbeat did not receive request on time
attributes.maintenance_days Array of strings An array of maintenance days to set. If a maintenance window is overnight both affected days should be set. Allowed values are ['mon', 'tue', 'wed', 'thu', 'fri', 'sat', 'sun'] or any subset of these days.
attributes.maintenance_from String Start of the maintenance window each day. We won't check your website during this window. Example: 01:00:00
attributes.maintenance_to String End of the maintenance window each day. Example: 03:00:00
attributes.maintenance_timezone String The timezone to use for the maintenance window each day. Defaults to UTC. The accepted values can be found in the Rails TimeZone documentation. https://api.rubyonrails.org/classes/ActiveSupport/TimeZone.html

Previous article

Delete existing heartbeat

Next article

List all existing heartbeat groups