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
Content-type
String

Body parameters

paused
boolean
name
string
sort_index
integer
201

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",
      "paused": false
    }
  }
}

Example cURL

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