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
    4. Migrating to pay as you go
  9. API
    1. Get started with API
  10. Monitors API
    1. Monitors
    2. Monitor groups
    3. Heartbeats
    4. Heartbeat groups
      1. List all existing heartbeat groups GET
      2. Get a single heartbeat group GET
      3. Create a new heartbeat group POST
      4. Update an existing heartbeat group PATCH
      5. Delete an existing heartbeat group DELETE
      6. Heartbeat groups API response params
  11. On-call & Incidents API
    1. On-call calendar
    2. On-call calendar events
    3. Escalation policies
    4. Escalation policy groups
    5. Severities
    6. Severity groups
    7. Incidents
    8. 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. Slack Integrations
    11. Outgoing Webhook integrations
    12. Splunk On-Call integrations
    13. 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

Create a new heartbeat group

Returns either a newly created heartbeat group, or validation errors.

POST https://uptime.betterstack.com/api/v2/heartbeat-groups

Headers

Authorization
required string

Bearer $TOKEN

Content-type
String

application/json

Body parameters

team_name
string

Required if using global API token to specify the team which should own the resource

paused
boolean

Set to true to pause monitoring for any existing heartbeats in the group — we won't notify you about downtime. Set to false to resume monitoring for any existing heartbeats in the group.

name
string

A name of the group that you can see in the dashboard.

sort_index
integer

Set sort_index to specify how to sort your heartbeat groups.

201

Returns newly created heartbeat group

Response body

{
  "data": {
    "id": "123456",
    "type": "heartbeat_group",
    "attributes": {
      "name": "Backend services",
      "sort_index": 0,
      "created_at": "2020-10-03T20:20:43.547Z",
      "updated_at": "2020-10-03T20:20:43.547Z",
      "team_name": "Test team",
      "paused": false
    }
  }
}

Example cURL

Example
curl --request POST \
  --url https://uptime.betterstack.com/api/v2/heartbeat-groups \
  --header "Authorization: Bearer $TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Backend services"
}'

Previous article

Get a single heartbeat group

Next article

Update an existing heartbeat group