This page describes the available API methods for manipulating monitor groups.

MonitorGroup object description

The following MonitorGroup object is used in the API methods described below:

Name Description
MonitorGroupGuid The unique identifier for this monitor group.
Description A string containing a descriptive name
IsAll Indicates whether this group is the "All Monitors" system group. True or False.

All Monitors group

The All Monitors group (the description of this group may be named differently, depending on the language in your account) is a system group that always contains all monitors. You cannot make any changes to this group. Using the Guid of this group is useful for operations that affect an entire group, such as starting/stopping all monitors or alerts.

Monitor group management endpoints

The following API endpoints are available for creating, modifying and removing monitor groups and for adding/removing members in those groups.

Request type Endpoint Usage
GET /MonitorGroup Gets all monitor groups
POST /MonitorGroup Creates a new monitor group
GET /MonitorGroup/{monitorGroupGuid} Gets the details of a monitor group
PUT /MonitorGroup/{monitorGroupGuid} Updates an existing monitor group
DELETE /MonitorGroup/{monitorGroupGuid} Deletes a monitor group
GET /MonitorGroup/{monitorGroupGuid}/Members Gets a list of all monitors that are member of a monitor group
POST /MonitorGroup/{monitorGroupGuid}/Members/{monitorGuid} Adds the specified monitor to the monitor group
DELETE /MonitorGroup/{monitorGroupGuid}/Members/{monitorGuid} Removes the specified monitor from the monitor group

Additional monitor group operations

The following API endpoints are available to perform operations on all monitors contained in a group:

Request type Endpoint Usage
POST /MonitorGroup/{monitorGroupGuid}/StopAllMonitors Stops all monitors in the specified monitor group
POST /MonitorGroup/{monitorGroupGuid}/StartAllMonitors Starts all monitors in the specified monitor group
POST /MonitorGroup/{monitorGroupGuid}/StopAllMonitorAlerts Stops alerting for all monitors in the specified monitor group
POST /MonitorGroup/{monitorGroupGuid}/StartAllMonitorAlerts Starts alerting for all monitors in the specified monitor group
POST /MonitorGroup/{monitorGroupGuid}/AddMaintenancePeriodToAllMembers Adds the provided maintenance period to all monitors in the group specified