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
      1. Monitors API
      2. Monitor groups API
        1. List monitor groups GET
        2. Get monitor group GET
        3. List monitors in group GET
        4. Create monitor group POST
        5. Update monitor group PATCH
        6. Remove monitor group DELETE
        7. Response attributes
    3. Heartbeats
    4. On-call & incidents
    5. Status pages
    6. Metadata
    7. Integrations

Update monitor group

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

PATCH https://uptime.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 any existing monitors in the group — we won't notify you about downtime. Set to false to resume monitoring for any existing monitors in the group.

name
string

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

sort_index
integer

Set sort_index to specify how to sort your monitor groups.

200

Returns updated monitor 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
    }
  }
}

Example cURL

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

Previous article

Create monitor group

Next article

Remove monitor group