Update monitor group

Update the attributes of an existing monitor group. Send only the parameters you wish to change (e.g. name).

PATCH https://incidents.betterstack.com/api/v2/monitor-groups/{monitor_group_id}

URL parameters

monitor_group_id

required string

The ID of the monitor group you want to update

Headers

Authorization

required string

Bearer $TOKEN

Content-Type

string

application/json

Body parameters

paused

boolean

Set to true to pause monitoring for every monitor currently in the group. We won't notify you about downtime. Set to false to resume the paused monitors, which needs room in your plan's monitor quota for all of them and a plan that includes each of their monitor types, such as Playwright.

name

string

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

sort_index

integer

The position of the group in your list of monitor groups, lower values first. position is accepted as an alias.

200

Returns updated monitor group data

Response body

{
  "data": {
    "id": "95251342",
    "type": "monitor_group",
    "attributes": {
      "name": "Backend services 2",
      "sort_index": null,
      "created_at": "2020-10-03T20:20:43.547Z",
      "updated_at": "2020-10-03T20:20:43.547Z",
      "team_name": "Test team",
      "paused": true
    }
  }
}

403

Every monitor in the group is paused and your plan can't resume all of them. Nothing changes, not even the other parameters you sent.

Response body

{
  "errors": "Monitor quota reached. Please upgrade your account to unpause the monitors in this group."
}

Example cURL

Example

Copied!

curl --request PATCH \
  --url https://incidents.betterstack.com/api/v2/monitor-groups/95251342 \
  --header "Authorization: Bearer $TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Backend services 2"
}'

Create monitor group

Remove monitor group

Explore documentation

Update monitor group

Example cURL

Please accept cookies