Explore documentation
  1. Welcome to Uptime 👋
  2. Frequently Asked Questions
  3. On-call scheduling and alerting
    1. Get started
    2. Sending alerts to Slack ↗
    3. Connecting external calendars
    4. Advanced guide
  4. Incidents
    1. Get started
    2. Advanced guide
  5. Monitoring
    1. Get started
    2. Working with monitors
    3. Customizing monitors
    4. Monitor types
  6. Status pages
    1. Get started
    2. Advanced guide
  7. Uptime API
    1. Getting an API token
    2. Monitors
    3. Heartbeats
      1. Heartbeats API
      2. Heartbeat groups API
        1. List heartbeat groups GET
        2. Get heartbeat group GET
        3. List heartbeats in group GET
        4. Create heartbeat group POST
        5. Update heartbeat group PATCH
        6. Remove heartbeat group DELETE
        7. Response attributes
    4. On-call & incidents
    5. Status pages
    6. Metadata
    7. Integrations

Create 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

List heartbeats in a group

Next article

Update heartbeat group