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
isFluidic	indicates if the new (fluidic) UI layout is used	Boolean	-	No
page	current page number for pagination	Integer	-	No
rows	number of records per page	Integer	Allowed values: 1-1000, 2000	No
sortByType	sort order (asc/desc)	String	Allowed values: asc, desc, ASC, DESC	No
sortByColumn	column name used for sorting	String	Allowed values: groupDisplayName, description, groupType, displayGroupType, status, count, DISPLAYNAME, availability, isSuppressed, memberAvailability	No
_search	flag to indicate if it's a search query	Boolean	-	No
nd	request timestamp	Long	-	No
isGroupPage	specifies if the request is from the group view page	Boolean	-	No
filters	applies filtering conditions to group results	JSONObject	groupOp - String - Allowed values: AND rules - JSONArray - --> field - String - Allowed values: groupDisplayName, description, groupType, displayGroupType, status, count, DISPLAYNAME, availability, isSuppressed, memberAvailability --> op - String - Allowed values: cn, eq --> data - String - Allowed characters: A-Z, a-z, all Unicode letters, 0-9, space( ), dot(.), exclamation(!), colon(:), at(@), hash(#), percent(%), dollar($), equal(=), greater than(>), less than(<), ampersand(&), plus(+), asterisk(*), hyphen(-), backslash(), slash(/), single quote('), comma(,), underscore(_), parenthesis(()), tilde(~), backtick(`), square brackets([ ]), curly braces({}), caret(^), semicolon(;), pipe(\|), question mark(?), double quote("), all non-Basic Latin characters	No

Sample Response

HTTP Code: 200

[ { "groupType": "Interface", "isSuppressed": false, "groupID": "3127", "count": "4", "description": "No Description", "statusImg": "/images/devices/status2.gif", "availability": "NA", "statusLabel": "Trouble", "groupDisplayName": "DevParent", "groupName": "devparent-3127", "suppressedMessage": "", "displayGroupType": "Interface", "status": "2"}, { "groupType": "Device", "isSuppressed": false, "groupID": "3128", "count": "4", "description": "Testing", "statusImg": "/images/devices/status5.gif", "availability": "NA", "statusLabel": "Clear", "groupDisplayName": "DevCrir", "groupName": "devcrir-3128", "suppressedMessage": "", "displayGroupType": "Device", "status": "5"}]

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=NorthBayRegion-4201&period=3&snapType=LogicalDeviceGroup

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API Key to access your OpManager server.	String	-	Yes
groupName	Name of the group with MOID appended in the suffix.	String	Allowed characters: A-Z, a-z, all Unicode letters, 0-9, space( ), dot(.), exclamation(!), colon(:), at(@), hash(#), dollar($), hyphen(-), underscore(_), backslash(\), slash(/), single quote('), comma(,)	Yes
period	Time for which the availability data is to be fetched.[Example: twfourhours(3)]	Integer	Allowed values: 3	Yes
snapType	Group Snapshot type.	String	Allowed values: LogicalDeviceGroup, LogicalIntfGroup, LogicalGroup, LogicalIPSLAGroup	No
expand	specifies whether to include detailed device information within the logical group	Boolean	-	No

Sample Response

HTTP Code: 200

{ "GroupDetails":{ "groupType": "Interface", "groupID": "3127", "count": "4", "description": "No Description", "statusImg": "/images/devices/status2.gif", "statusLabel": "Trouble", "groupDisplayName": "DevParent", "groupName": "devparent-3127", "interfaceInterface_Count": "4", "alertCount": 7, "statusChangeCount": 3, "displayGroupType": "Interface", "status": "2"}, "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"}}, "alarmProfileDetails": []}

Error Response

View common error responses

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

getLogicalGroupAlerts

Fetches the alarms generated from the members (devices/interfaces) of the given group.

HTTP Method

GET

API URL

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

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API Key to access your OpManager server.	String	-	Yes
groupName	Name of the group	String	Allowed characters: A-Z, a-z, all Unicode letters, 0-9, space( ), dot(.), exclamation(!), colon(:), at(@), hash(#), dollar($), hyphen(-), underscore(_), backslash(\), slash(/), single quote('), comma(,)	Yes
expand	specifies whether to include detailed device information within the logical group	Boolean	-	No

Sample Response

HTTP Code: 200

[ { "severity": "Critical", "groupType": "device", "severityString": "/images/devices/status1.gif", "modTime": "25 Nov 2022 02:27:11 PM IST", "displayName": "Pradh", "name": "opm-server", "alarmId": 1, "type": "device", "message": "Device Down: No response from device for last 5 polls", "entity": "opm-server_Poll", "status": 1}, { "severity": "Attention", "groupType": "device", "severityString": "/images/devices/status3.gif", "modTime": "25 Nov 2022 07:17:49 PM IST", "displayName": "HPswitch9", "name": "10.5.5.1", "alarmId": 33, "type": "device", "message": "Device not responding: Probably down or busy", "entity": "10.5.5.1_Poll", "status": 3}, { "severity": "Attention", "groupType": "device", "severityString": "/images/devices/status3.gif", "modTime": "25 Nov 2022 02:50:59 PM IST", "displayName": "HPswitch9", "name": "10.5.5.1", "alarmId": 26, "type": "device", "message": "Response Time is 21 ms, threshold value for this device is 10 ms", "entity": "154_Device", "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	Name of the Device/Interface Group having suffix as '- '. [Example: Demo-123 ]	String	Allowed characters: A-Z, a-z, all Unicode letters, 0-9, space( ), dot(.), exclamation(!), colon(:), at(@), hash(#), dollar($), hyphen(-), underscore(_), backslash(\), slash(/), single quote('), comma(,)	Yes
expand	specifies whether to include detailed device information within the logical group	Boolean	-	No

Sample Response

HTTP Code: 200

[ { "groupType": "Device", "statusStr": "Clear", "displayname": "10.5.5.1", "name": "10.5.5.1", "ipAddress": "10.5.5.1", "type": "Device", "elemRedir": "device", "moid": "304", "statusNum": "5"}, { "groupType": "Device", "statusStr": "Clear", "displayname": "10.5.5.2", "name": "10.5.5.2", "ipAddress": "10.5.5.2", "type": "Device", "elemRedir": "device", "moid": "324", "statusNum": "5"}, { "groupType": "Device", "statusStr": "Attention", "displayname": "10.5.5.3", "name": "10.5.5.3", "ipAddress": "10.5.5.3", "type": "Device", "elemRedir": "device", "moid": "3125", "statusNum": "3"}]

Error Response

View common error responses

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

addToGroup

Allows you to add device(s) to the specified 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	Name of the group to add devices to	String	Allowed characters: A-Z, a-z, all Unicode letters, 0-9, space( ), dot(.), exclamation(!), colon(:), at(@), hash(#), dollar($), hyphen(-), underscore(_), backslash(\), slash(/), single quote('), comma(,)	Yes
groupType	Type of the group	String	Allowed values: device, interface	Yes
selectedMembers	list of devices or members to be added to the group	String	-	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