Groups

listAllLogicalGroups

Lists all the groups available in OpManager. Also provides basic group information such as members count and group health.

HTTP Method

GET

API URL

https://localhost:8060/api/json/admin/listAllLogicalGroups?apiKey=***************

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API key to access your OpManager server.	String	-	Yes
isGroupPage	If set to false (default), returns all groups. If set to true, returns paginated results and requires the page and rows parameters.	Boolean	-	No
page	Page number for pagination.	Integer	page=1	No
rows	Number of records to return per page.	Integer	rows=100	No
sortByColumn	Column name by which to sort the results.	String	Allowed values: groupDisplayName, description, groupType, displayGroupType, status, count, DISPLAYNAME, availability, isSuppressed, memberAvailability	No
sortByType	Sort by ascending or descending.	String	Allowed values: asc, desc	No

Sample Response

HTTP Code: 200

[
  {
    "total": 141,
    "page": 1,
    "rows": [
      {
        "groupType": "Interface",
        "isSuppressed": false,
        "memberAvailability": "100",
        "groupID": "132995",
        "count": "4",
        "description": "No Description",
        "statusImg": "/images/devices/status5.gif",
        "availability": "100",
        "statusLabel": "Clear",
        "groupDisplayName": "ServerGroup",
        "groupName": "ServerGroup-132995",
        "suppressedMessage": "",
        "displayGroupType": "Interface",
        "status": "5"
      },
      {
        "groupType": "Device",
        "isSuppressed": false,
        "memberAvailability": "0",
        "groupID": "132002",
        "count": "1",
        "description": "No Description",
        "statusImg": "/images/devices/status5.gif",
        "availability": "100",
        "statusLabel": "Clear",
        "groupDisplayName": "Agent",
        "groupName": "Agent-132002",
        "suppressedMessage": "",
        "displayGroupType": "Device",
        "status": "5"
      }
    ],
    "records": 282
  }
]

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

getLogicalGroupInfo

Provides details such as members count, group status, etc of the given group.

HTTP Method

GET

API URL

https://localhost:8060/api/json/admin/getLogicalGroupInfo?apiKey=***************&groupName=ServerGroup-52983&period=3

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API key to access your OpManager server.	String	-	Yes
groupName	Internal name of the logical group. This can be retrieved from the groupName field in the listAllLogicalGroups API response	String	-	Yes
period	Value must be set to 3.	Integer		Yes

Sample Response

HTTP Code: 200

{
  "GroupDetails": {
    "groupType": "Device",
    "groupID": "52983",
    "count": "2",
    "description": "No Description",
    "statusImg": "/images/devices/status1.gif",
    "statusLabel": "Critical",
    "deviceDevice_Count": "2",
    "groupDisplayName": "ServerGroup",
    "groupName": "ServerGroup-52983",
    "alertCount": 5,
    "statusChangeCount": 2,
    "displayGroupType": "Device",
    "status": "1"
  },
  "DashBoardDetails": {
    "Distribution": {
      "data": {
        "chartData": [
          {
            "seriesname": "99.99 - 100",
            "data": [
              [
                1759818600000,
                100
              ],
              [
                1759822200000,
                100
              ],
              [
                1759825800000,
                100
              ]
            ],
            "yaxiscolumnorder": [
              0
            ]
          },
          {
            "seriesname": "99 - 99.99",
            "data": [
              [
                1759818600000,
                0
              ],
              [
                1759822200000,
                0
              ],
              [
                1759825800000,
                0
              ]
            ],
            "yaxiscolumnorder": [
              0
            ]
          },
          {
            "seriesname": "90 - 99",
            "data": [
              [
                1759818600000,
                0
              ],
              [
                1759822200000,
                0
              ],
              [
                1759825800000,
                0
              ]
            ],
            "yaxiscolumnorder": [
              0
            ]
          },
          {
            "seriesname": "50 - 90",
            "data": [
              [
                1759818600000,
                0
              ],
              [
                1759822200000,
                0
              ],
              [
                1759825800000,
                0
              ]
            ],
            "yaxiscolumnorder": [
              0
            ]
          },
          {
            "seriesname": "10 - 50",
            "data": [
              [
                1759818600000,
                0
              ],
              [
                1759822200000,
                0
              ],
              [
                1759825800000,
                0
              ]
            ],
            "yaxiscolumnorder": [
              0
            ]
          },
          {
            "seriesname": "0 - 10",
            "data": [
              [
                1759818600000,
                0
              ],
              [
                1759822200000,
                0
              ],
              [
                1759825800000,
                0
              ]
            ],
            "yaxiscolumnorder": [
              0
            ]
          },
          {
            "seriesname": "Not Monitored",
            "data": [
              [
                1759818600000,
                0
              ],
              [
                1759822200000,
                0
              ],
              [
                1759825800000,
                0
              ]
            ],
            "yaxiscolumnorder": [
              0
            ]
          }
        ],
        "xyTitles": [
          "Time",
          "Distribution (%)"
        ]
      },
      "displayName": "Availability Distribution"
    }
  }
}

Error Response

View common error responses

Rate limit: 50 requests per minute. Exceeding this limit will block requests for 1 minute

getLogicalGroupAlerts

Retrieves the alarms generated from the members of the given group.

HTTP Method

GET

API URL

https://localhost:8060/api/json/admin/getLogicalGroupAlerts?apiKey=***************&groupName=servergroup-4201

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API key to access your OpManager server.	String	-	Yes
groupName	Internal name of the logical group. This can be retrieved from the groupName field in the listAllLogicalGroups API response.	String	-	Yes

Sample Response

HTTP Code: 200

[
    {
        "severity": "Attention",
        "groupType": "device",
        "severityString": "/images/devices/status3.gif",
        "modTime": "8 Oct 2025 11:50:59 AM IST",
        "displayName": "xxx.xxx.xx.x",
        "name": "xxx.xxx.xx.x",
        "alarmId": 2101,
        "message": "Device not responding: Probably down or busy",
        "type": "device",
        "entity": 2101,
        "status": 3
    },
    {
        "severity": "Attention",
        "groupType": "device",
        "severityString": "/images/devices/status3.gif",
        "modTime": "8 Oct 2025 11:50:59 AM IST",
        "displayName": "ServersProduction",
        "name": "ServersProduction-3128",
        "alarmId": 2102,
        "message": "Severity of the group is changed from Clear to Attention",
        "type": "device",
        "entity": 2102,
        "status": 3
    }
]

Error Response

View common error responses

Rate limit: 50 requests per minute. Exceeding this limit will block requests for 1 minute

listLogicalGroupMembers

Provides information on the members available in the given group.

HTTP Method

GET

API URL

https://localhost:8060/api/json/admin/listLogicalGroupMembers?apiKey=***************&groupName=NorthBayRegion-4201

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apikey	API key to access your OpManager server.	String	-	Yes
groupName	Internal name of the logical group. This can be retrieved from the groupName field in the listAllLogicalGroups API response.	String	-	Yes

Sample Response

HTTP Code: 200

[
  {
    "groupType": "Device",
    "statusStr": "Critical",
    "displayname": "TestServer",
    "name": "testserver.example.com",
    "ipAddress": "10.X.X.X",
    "type": "Windows Server",
    "moid": "34950",
    "statusNum": "1"
  },
  {
    "groupType": "Device",
    "statusStr": "Critical",
    "displayname": "TestServer2",
    "name": "testserver2.example.com",
    "ipAddress": "10.X.X.X",
    "type": "Windows Server",
    "moid": "34951",
    "statusNum": "1"
  }
]

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

addToGroup

Add one or more devices or interfaces to an existing Group.

HTTP Method

POST

API URL

https://localhost:8060/api/json/device/addToGroup?apiKey=***************************

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API key to access your OpManager server.	String	-	Yes
groupName	Internal name of the logical group. This can be retrieved from the groupName field in the listAllLogicalGroups API response.	String	-	Yes
groupType	Type of group	String	Allowed values: device \| interface.	Yes
selectedMembers	For Devices: The 'moid' value can be obtained from the 'moid' field of the listDevices API's response. For Interfaces: The 'id' value can be obtained from the 'id' field of the listInterfaces API response.	JSON String	Example: Key: selectedMembers Value: ["2","7"].	Yes

Sample Response

HTTP Code: 200

{
    "result": {
        "message": "The Device(s) have been associated to the group successfully."
    }
}

Error Response

View common error responses

Rate limit: 50 requests per minute. Exceeding this limit will block requests for 1 minute