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
  9. API
    1. Get started with API
  10. Monitors API
    1. Monitors
    2. Monitor groups
      1. List all existing monitor groups GET
      2. Get single monitor group GET
      3. Get all monitors of a monitor group GET
      4. Create a new monitor group POST
      5. Update an existing monitor group PATCH
      6. Delete an existing monitor group DELETE
      7. Monitor groups API response params
    3. Heartbeats
    4. Heartbeat groups
  11. On-call & Incidents API
    1. On-call calendar
    2. Escalation policies
    3. Escalation policy groups
    4. Severities
    5. Severity groups
    6. Incidents
    7. 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. Splunk On-Call integrations
    12. 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

Monitor groups API response params

Response body params

Namespace data

Parameter Type Values
id String The ID of the monitor group. String representation of number.
type String monitor_group
attributes Object Attributes object. See below.
attributes.name String Name of the monitor group. You will see this name in the dashboard.
attributes.sort_index Integer Specifies the sorting order of the monitor groups. Can be null.
attributes.created_at String (ISO DateTime format) When was the monitor group created. Example value "2020-10-03T20:20:43.547Z".
attributes.updated_at String (ISO DateTime format) When was the monitor group last updated. Example value "2020-10-03T20:20:43.547Z".
attributes.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.

Previous article

Delete an existing monitor group

Next article

List all existing heartbeats