Devices

List Devices

Lists all devices monitored by OpManager - Version 1 API

HTTP Method

GET

API URL

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

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API Key to access your OpManager server.	String	-	Yes
subnetName	Name of the subnet	String	-	No
type	Fetches the list of devices that fall under the given Device Type. [Example: type=Cisco2081]	String	Allowed characters: A-Z, a-z, all Unicode letters, 0-9, space( ), comma(,), dot(.), hyphen(-), underscore(_), parenthesis(()), slash(/), plus(+), exclamation(!), at(@), hash(#), dollar($), square brackets([ ]), caret(^), colon(:), semicolon(;), equals(=), single quote(')	No
category	Fetches the list of devices that fall under the given device category [Example: Server, Switch, etc.]	String	Allowed characters: A-Z, a-z, 0-9, space( ), underscore(_), hyphen(-), dot(.)	No
classification	Fetches the list of devices that fall under the given device category [Example: Server, Switch, etc.]	String	Allowed values: Network, Router, Switch, Printer, Server, PhysicalServer, Windows, Linux, MSSQL, Exchange, DomainController, Wireless, Firewall, IPMI, MonitoringAgent	No
isMapView	Is fetched from Maps page	Boolean	-	No
isFluidic	Set value as 'true' by default.(for internal purpose)	Boolean	-	No
isSubnet	Filters device by IP Subnet	Boolean	-	No
deviceName	Name of the device	String	-	No
app	Fetches the list of devices that have the given App in it and monitored in OpManager [Example: MSSQL, Exchange, Domain Controller]	String	-	No
bvName	Fetches the list of devices that are under the given Business View map name	String	-	No
vendorName	Fetches the list of devices that have the given vendor name	String	Allowed characters: A-Z, a-z, all Unicode letters, 0-9, hyphen(-), parenthesis(()), dot(.), comma(,), underscore(_), slash(/), space( ), hash(#)	No
vendor	Fetches the list of devices that have the given vendor name.	String	Allowed characters: A-Z, a-z, all Unicode letters, 0-9, hyphen(-), parenthesis(()), dot(.), comma(,), underscore(_), slash(/), space( ), hash(#)	No
protocol	Filter devices by protocol [Example: all\|SNMP\|WMI\|CLI\|VIWebService\|VIWMI\|CLI\|XenService\|PrismAPI\|NetAppAPI\|SMI]	String	-	No
severity	Filter devices by severity [Example: 1 (Critical), 2 (Trouble), 3 (Attention), 4 (service down), 5 (Clear), 7 (Unmanaged)]	String	Allowed characters: 1-11, comma(,)	No
state	List of states	String	Allowed characters: 1-11, comma(,)	No
subnet	Filters device by specific IP Subnet	String	-	No
page	To fetch devices in batches. This should be combinedly used with 'rows' parameter. [Example: page=1, rows=200, page=2, rows=200]	Integer	-	No
rows	To fetch devices in batches. This should be combinedly used with 'page' parameter [Example: page=1, rows=200, page=2, rows=200]	Integer	-	No
sortByType	Defining sort type to be ascending or descending	String	Allowed values: asc, desc , ASC, DESC	No
sortByColumn	Sorting device list by columns [Example: displayName, interfaceCount, ipaddress, type, etc.]	String	Allowed characters: A-Z, a-z, all Unicode letters, 0-9, underscore(_), space( )	No
selectedVTypes	Filter devices by Virtual device type	String	Allowed values: all, All, VMware, HyperV, Xen, Nutanix, Proxmox, VMware-VM, VMware-Host, VMware-vCenter, HyperV-Host, HyperV-VM, Xen-Host, Xen-VM, Nutanix-Cluster, Nutanix-Host, Nutanix-VM, Proxmox-Node, Proxmox-VM, Proxmox-Container, OPM-DEVICE	No
fileTemplate	filters devices linked with a specific file monitoring template	Long	-	No
folderTemplate	filters devices linked with a specific folder monitoring template	Long	-	No
getInterfaces	To fetch devices with associated interfaces. Boolean value: Allowed Values: The input must exactly match either true or false	Boolean	-	No
isStorage	Is storage device	Boolean	-	No
storageCategory	Storage category	String	Allowed values: RAID, TapeLibrary, FCSwitch, comma(,) (case-insensitive)	No
excludeStorage	Whether to exclude storage devices or not	Boolean	-	No
groupName	Filter devices by Group name	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(,)	No
filters	applies custom filter conditions to narrow device results	String	-	No
skipLocalhost	excludes the OpManager server (localhost) from the device list	Boolean	-	No
getMonitors	Includes device monitor details in the response.	Boolean	-	No
customFields	To fetch custom field values for the devices, supply the required custom field names in the 'customFields' param in the API request. Example: /api/json/device/listDevices?apiKey=***************&customFields=Building,Comments,Floor	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('), square brackets([ ]), comma(,)	No
selectedMonType	filters devices by specific monitor type	String	-	No
hideEmptyDevices	hides devices without any monitors or data	Boolean	-	No
probe_customer_id	filters devices by probe or customer ID	Long	Allowed values: >=1	No
excludeIPMI	Excludes IPMI devices	Boolean	-	No
excludeAP	Excludes Access points	Boolean	-	No
isLicenseView	shows device data based on license view	Boolean	-	No
isManaged	Whether to list managed device alone	Boolean	-	No
pageName	identifies the UI page or view requesting the data	String	Allowed values: Inventory	No
excludeAgent	Excludes agent based devices	Boolean	-	No

Sample Response

HTTP Code: 200

[ { "isSNMP": true, "ipaddress": "10.5.5.1", "isSuppressed": false, "statusStr": "Clear", "prettyTime": "2 days ago", "displayName": "10.5.5.1", "isNew": false, "type": "Windows 10", "vendorName": "Microsoft", "deviceName": "10.5.5.1", "moid": 13699, "statusNum": "5", "suppressedMessage": "", "addedTime": "15 Oct 2025 12:37:55 PM IST", "numericStatus": "5", "interfaceCount": 0, "id": "13699", "mapName": "Desktops_Map.netmap", "category": "Desktop", "status": "<img src='/images/devices/status5.gif'>Clear"}, { "isSNMP": true, "ipaddress": "10.5.5.2", "isSuppressed": false, "statusStr": "Clear", "prettyTime": "2 days ago", "displayName": "10.5.5.2", "isNew": false, "type": "Windows 2019", "vendorName": "Microsoft", "deviceName": "10.5.5.2", "moid": 13710, "statusNum": "5", "suppressedMessage": "", "addedTime": "15 Oct 2025 12:37:56 PM IST", "numericStatus": "5", "interfaceCount": 0, "id": "13710", "mapName": "Servers_Map.netmap", "category": "Server", "status": "<img src='/images/devices/status5.gif'>Clear"}]

Error Response

View common error responses

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

v2/listDevices

Lists all devices monitored by OpManager - Enhanced Version 2 API with additional fields

HTTP Method

GET

API URL

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

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API Key to access your OpManager server.	String	-	Yes
subnetName	Name of the subnet	String	-	No
type	Fetches the list of devices that fall under the given Device Type. [Example: type=Cisco2081]	String	Allowed characters: A-Z, a-z, all Unicode letters, 0-9, space( ), comma(,), dot(.), hyphen(-), underscore(_), parenthesis(()), slash(/), plus(+), exclamation(!), at(@), hash(#), dollar($), square brackets([ ]), caret(^), colon(:), semicolon(;), equals(=), single quote(')	No
category	Fetches the list of devices that fall under the given device category [Example: Server, Switch, etc.]	String	Allowed characters: A-Z, a-z, 0-9, space( ), underscore(_), hyphen(-), dot(.)	No
classification	Device category	String	Allowed values: Network, Router, Switch, Printer, Server, PhysicalServer, Windows, Linux, MSSQL, Exchange, DomainController, Wireless, Firewall, IPMI, MonitoringAgent	No
isMapView	Is fetched from Maps page	Boolean	-	No
isFluidic	Set value as 'true' by default.(for internal purpose)	Boolean	-	No
isSubnet	Filters device by IP Subnet	Boolean	-	No
deviceName	Name of the device	String	-	No
app	Fetches the list of devices that have the given App in it and monitored in OpManager [Example: MSSQL, Exchange, Domain Controller]	String	-	No
bvName	Fetches the list of devices that are under the given Business View map name	String	-	No
vendorName	Name of the Vendor	String	Allowed characters: A-Z, a-z, all Unicode letters, 0-9, hyphen(-), parenthesis(()), dot(.), comma(,), underscore(_), slash(/), space( ), hash(#)	No
vendor	Fetches the list of devices that have the given vendor name.	String	Allowed characters: A-Z, a-z, all Unicode letters, 0-9, hyphen(-), parenthesis(()), dot(.), comma(,), underscore(_), slash(/), space( ), hash(#)	No
protocol	Filter devices by protocol [Example: all\|SNMP\|WMI\|CLI\|VIWebService\|VIWMI\|CLI\|XenService\|PrismAPI\|NetAppAPI\|SMI]	String	-	No
severity	Filter devices by severity [Example: 1 (Critical), 2 (Trouble), 3 (Attention), 4 (service down), 5 (Clear), 7 (Unmanaged)]	String	Allowed characters: 1-11, comma(,)	No
state	List of states	String	Allowed characters: 1-11, comma(,)	No
subnet	Filters device by specific IP Subnet	String	-	No
page	To fetch devices in batches. This should be combinedly used with 'rows' parameter. [Example: page=1, rows=200, page=2, rows=200]	Integer	-	No
rows	To fetch devices in batches. This should be combinedly used with 'page' parameter [Example: page=1, rows=200, page=2, rows=200]	Integer	-	No
sortByType	Defining sort type to be ascending or descending	String	Allowed values: asc, desc , ASC, DESC	No
sortByColumn	Sorting device list by columns [Example: displayName, interfaceCount, ipaddress, type, etc.]	String	Allowed characters: A-Z, a-z, all Unicode letters, 0-9, underscore(_), space( )	No
selectedVTypes	Filter devices by Virtual device type [Allowed values: VMware-VM, VMware-Host, VMware-vCenter, HyperV-VM, HyperV-Host, Xen-VM, Xen-Host, Nutanix-VM, Nutanix-Host, Nutanix-Cluster]	String	Allowed values: all, All, VMware, HyperV, Xen, Nutanix, Proxmox, VMware-VM, VMware-Host, VMware-vCenter, HyperV-Host, HyperV-VM, Xen-Host, Xen-VM, Nutanix-Cluster, Nutanix-Host, Nutanix-VM, Proxmox-Node, Proxmox-VM, Proxmox-Container, OPM-DEVICE	No
fileTemplate	filters devices linked with a specific file monitoring template	Long	-	No
folderTemplate	filters devices linked with a specific folder monitoring template	Long	-	No
getInterfaces	To fetch devices with associated interfaces. Boolean value: Allowed Values: The input must exactly match either true or false	Boolean	-	No
isStorage	Is storage device	Boolean	-	No
storageCategory	Storage category	String	Allowed values: RAID, TapeLibrary, FCSwitch, comma(,) (case-insensitive)	No
excludeStorage	Whether to exclude storage devices or not	Boolean	-	No
groupName	Filter devices by Group name	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(,)	No
filters	applies custom filter conditions to narrow device results	String	-	No
skipLocalhost	excludes the OpManager server (localhost) from the device list	Boolean	-	No
getMonitors	Includes device monitor details in the response.	Boolean	-	No
customFields	To fetch custom field values for the devices, supply the required custom field names in the 'customFields' param in the API request. Example: /api/json/device/listDevices?apiKey=***************&customFields=Building,Comments,Floor	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('), square brackets([ ]), comma(,)	No
selectedMonType	filters devices by specific monitor type	String	-	No
hideEmptyDevices	hides devices without any monitors or data	Boolean	-	No
probe_customer_id	filters devices by probe or customer ID	Long	Allowed values: >=1	No
excludeIPMI	Excludes IPMI devices	Boolean	-	No
excludeAP	Excludes Access points	Boolean	-	No
isLicenseView	shows device data based on license view	Boolean	-	No
isManaged	Whether to list managed device alone	Boolean	-	No
pageName	identifies the UI page or view requesting the data	String	Allowed values: Inventory	No
excludeAgent	Excludes agent based devices	Boolean	-	No

Sample Response

HTTP Code: 200

{ "total": 0, "page": 1, "rows": [ { "isSNMP": true, "ipaddress": "10.5.5.1", "isSuppressed": false, "statusStr": "Clear", "prettyTime": "5 hours ago", "displayName": "10.5.5.1", "isNew": false, "type": "Windows 10", "vendorName": "Microsoft", "deviceName": "10.5.5.1", "moid": 341, "statusNum": "5", "suppressedMessage": "", "addedTime": "7 Oct 2025 11:08:30 AM IST", "interfaceCount": 0, "id": "341", "category": "Desktop"}, { "isSNMP": true, "ipaddress": "10.5.5.2", "isSuppressed": false, "statusStr": "Clear", "prettyTime": "5 hours ago", "displayName": "10.5.5.2", "isNew": false, "type": "Windows 2019", "vendorName": "Microsoft", "deviceName": "10.5.5.2", "moid": 362, "statusNum": "5", "suppressedMessage": "", "addedTime": "7 Oct 2025 11:08:31 AM IST", "interfaceCount": 0, "id": "362", "category": "Server"} ], "records": 2}

Error Response

View common error responses

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

getDeviceInfo

Identifies and lists inventory attributes like HDD, RAM, Model, MACAddress, ServiceTag, Manufacturer, SerialNumber, OperatingSystem, and SoftwareVersion.

HTTP Method

GET

API URL

https://localhost:8060/api/json/device/getDeviceInfo?apiKey=***************&deviceName=xxx.xxx.xx.x

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API Key to access your OpManager server.			Yes
deviceName/ipAddress/dnsName	Either one of these three parameters can be used to retrieve the device details. These parameters are the managed Entity name as seen in the URL of the device snapshot page (OR 'deviceName' property value in the listDevices API response), or the IP address of the device, or the DNS name of the device.	deviceName(String)/ipAddress(ipAddress Regex)/dnsName(String)		Yes

Sample Response

HTTP Code: 200

{ "OperatingSystem":"Windows", "MACAddress":"00:00:00:11:11:11", "SoftwareVersion":"10.0.1", "SerialNumber":"RKRRRR", "ServiceTag":"ADRRB126", "Model":"ProLiant BL460c", "Manufacturer":"HP", "HDD":"512", "RAM":"16384", "..

Error Response

View common error responses

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

Set Device Info

Allows administrators to configure and update device attributes such as HDD, RAM, Model, MACAddress, ServiceTag, Manufacturer, SerialNumber, OperatingSystem, and SoftwareVersion

HTTP Method

POST

API URL

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

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API Key to access your OpManager server.	String	-	Yes
deviceName	Name of the device to update	String	-	Yes
location	Device location	String	-	No
ipAddress	IP address of the device	ipAddress regex	-	No
dnsName	the DNS name of the device	String	-	No
values	Properties fetched from the device using this api. This includes: HDD, RAM, Model, MACAddress, ServiceTag, Manufacturer, SerialNumber, OperatingSystem, and SoftwareVersion	JSONArray	-	Yes
category	Device category	String	-	No

Sample Response

HTTP Code: 200

{ "result":{ "status": "Success", "message": "values updated successfully"}}

Error Response

View common error responses

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

Get Device Notes

Retrieves notes associated with a specific device

HTTP Method

GET

API URL

https://localhost:8060/api/json/device/getDeviceNotes?apiKey=***************&deviceName=devicename

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API Key to access your OpManager server.	String	-	Yes
deviceName	Name of the device	String	-	Yes

Sample Response

HTTP Code: 200

{ "notes": [ { "noteId": "101", "note": "Device maintenance completed on 2025-01-15", "createdBy": "admin", "createdTime": "2025-01-15 14:30:00"} ]}

Error Response

View common error responses

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

getInfrastructureDetailsView

Retrieves detailed infrastructure view for devices and their relationships

HTTP Method

GET

API URL

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

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API Key to access your OpManager server.	String	-	Yes
categoryName	Name of the device category. [Example: Server, Desktop etc]	String	Allowed characters: A-Z, a-z, 0-9, space( ), underscore(_), hyphen(-), dot(.)	Yes
viewLength	number of records to display	Integer	-	No
startPoint	starting index for pagination	Integer	-	No
isIphoneRequest	indicates if the request comes from an iPhone client	Boolean	-	No

Sample Response

HTTP Code: 200

{ "InfrastructureDetailsView":{ "Details": [ { "intfCount": "0", "severity": "5", "displayName": "10.5.5.1", "name": "10.5.5.1", "IpAddress": "10.5.5.1", "type": "Linux", "monitors":{ "DiskUtilization": 0, "CPUUtilization": 0, "MemoryUtilization": 0}, "status": "Clear"}, { "intfCount": "0", "severity": "5", "displayName": "10.5.5.2", "name": "10.5.5.2", "IpAddress": "10.5.5.2", "type": "Windows 2016", "monitors":{ "DiskUtilization": 0, "CPUUtilization": 0, "MemoryUtilization": 0}, "status": "Clear"} ], "TotalRecords": "2"}}

Error Response

View common error responses

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

getDeviceSummary

Provides the device details as in the Device snapshot page

HTTP Method

GET

API URL

https://localhost:8060/api/json/device/getDeviceSummary?apiKey=**************&name=opmserver.testdomain.com

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API Key to access your OpManager server.			Yes
name	Name of the device - Managed Entity name as seen in the URL of device snapshot page OR 'deviceName' property value in the listDevices API response.	String	-	Yes
isFluidic	Set value as TRUE by default. (for internal purpose)	String	-	No
snapType	Type of the device snapshot. If the device is monitored only in OpManager, set value as 'MonitoringDevice'. If Flow monitoring is enabled for this device, set value as 'FlowDevice'	String	-	No
RouterID	Router ID of the device if the snapType is set as 'FlowDevice'.	String	-	No

Sample Response

HTTP Code: 200

{ "NFA_ID": "", "recBandwidth": "1", "IntfIpaddress": "127.0.0.1", "instance": "101", "displayName": "ciscostackswitchdevice874", "Util": "5", "availability":{ "Down": 0, "Dependent Unavailable": 0, "On Hold": 0, "Not Monitored": 0, "Parent Down": 98.34, "On Maintenance": 0, "Up": 1.66}, "avgOutPackets": "500 ", "outTraffic": "0.008 ", "moID": "10000000310", "isIPAvailable": true, "inSpeedDisplayValue": "1 bps", "intfDisplayName": "GigabitEthernet1/0/1", "txUtil": "0.89", "typeIdDescr": "Ethernet (6)", "operStateImg": "", "isSubInterface": "false", "managed": "true", "snapDetails":{ "snapList": [ { "indexCount": 0, "ondemandWidget": false, "refresh": false, "type": "IntfSummary", "sizex": 10, "expand": false, "apiurl": "/client/api/json/device/getInterfaceSummary", "rowNum": 1, "parameter": "interfaceName", "isEnabled": true, "colNum": 1, "name": "opm.interface.summary", "header": false, "id": 10000000081, "snapid": 10000000081, "snapshotData":{ "EE_PROBE_REQ": "true"}, "expandtime": false, "parameters": [], "sizey": 12, "timeSelection": false, "desc": "dashboard.name.nwconfig"}, { "indexCount": 1, "ondemandWidget": false, "refresh": false, "type": "IntfGraphs", "sizex": 10, "expand": false, "apiurl": "/client/api/json/device/getInterfaceGraphs", "rowNum": 13, "parameter": "interfaceName", "isEnabled": true, "colNum": 1, "name": "opm.interface.graphs", "header": true, "id": 10000000082, "snapid": 10000000082, "snapshotData":{ "EE_PROBE_REQ": "true"}, "expandtime": false, "parameters": [ { "param": "graphName", "paramData": [], "value": "totalPackets"}, { "param": "isFluidic", "paramData": [], "value": "true"}, { "paramType": "opmtime", "param": "period", "paramData": [], "value": "Today"} ], "sizey": 13, "timeSelection": true, "desc": "webclient.devices.details.totalbytes"}, { "indexCount": 2, "ondemandWidget": false, "refresh": false, "type": "IntfGraphs", "sizex": 10, "expand": false, "apiurl": "/client/api/json/device/getInterfaceGraphs", "rowNum": 15, "parameter": "interfaceName", "isEnabled": true, "colNum": 1, "name": "opm.interface.graphs", "header": true, "id": 10000000083, "snapid": 10000000083, "snapshotData":{ "EE_PROBE_REQ": "true"}, "expandtime": false, "parameters": [ { "param": "graphName", "paramData": [], "value": "traffic"}, { "param": "isFluidic", "paramData": [], "value": "true"}, { "paramType": "opmtime", "param": "period", "paramData": [], "value": "Today"} ], "sizey": 13, "timeSelection": true, "desc": "webclient.snapshot.name.Interface.Traffic"}, { "indexCount": 3, "ondemandWidget": false, "refresh": false, "type": "IntfGraphs", "sizex": 10, "expand": false, "apiurl": "/client/api/json/device/getInterfaceGraphs", "rowNum": 17, "parameter": "interfaceName", "isEnabled": true, "colNum": 1, "name": "opm.interface.graphs", "header": true, "id": 10000000084, "snapid": 10000000084, "snapshotData":{ "EE_PROBE_REQ": "true"}, "expandtime": false, "parameters": [ { "param": "graphName", "paramData": [], "value": "utilization"}, { "param": "isFluidic", "paramData": [], "value": "true"}, { "paramType": "opmtime", "param": "period", "paramData": [], "value": "Today"} ], "sizey": 13, "timeSelection": true, "desc": "webclient.snapshot.name.Interface.Utilization"}, { "indexCount": 4, "ondemandWidget": false, "refresh": false, "type": "IntfGraphs", "sizex": 10, "expand": false, "apiurl": "/client/api/json/device/getInterfaceGraphs", "rowNum": 19, "parameter": "interfaceName", "isEnabled": true, "colNum": 1, "name": "opm.interface.graphs", "header": true, "id": 10000000085, "snapid": 10000000085, "snapshotData":{ "EE_PROBE_REQ": "true"}, "expandtime": false, "parameters": [ { "param": "graphName", "paramData": [], "value": "errors"}, { "param": "isFluidic", "paramData": [], "value": "true"}, { "paramType": "opmtime", "param": "period", "paramData": [], "value": "Today"} ], "sizey": 13, "timeSelection": true, "desc": "webclient.devices.details.errndiscards"}, { "indexCount": 5, "ondemandWidget": false, "refresh": false, "type": "IntfGraphs", "sizex": 10, "expand": false, "apiurl": "/client/api/json/device/getInterfaceGraphs", "rowNum": 21, "parameter": "interfaceName", "isEnabled": true, "colNum": 1, "name": "opm.interface.graphs", "header": true, "id": 10000000086, "snapid": 10000000086, "snapshotData":{ "EE_PROBE_REQ": "true"}, "expandtime": false, "parameters": [ { "param": "graphName", "paramData": [], "value": "discardRate"}, { "param": "isFluidic", "paramData": [], "value": "true"}, { "paramType": "opmtime", "param": "period", "paramData": [], "value": "Today"} ], "sizey": 13, "timeSelection": true, "desc": "webclient.snapshot.name.Discard.Rate"}, { "indexCount": 6, "ondemandWidget": false, "refresh": false, "type": "IntfGraphs", "sizex": 10, "expand": false, "apiurl": "/client/api/json/device/getInterfaceGraphs", "rowNum": 23, "parameter": "interfaceName", "isEnabled": true, "colNum": 1, "name": "opm.interface.graphs", "header": true, "id": 10000000087, "snapid": 10000000087, "snapshotData":{ "EE_PROBE_REQ": "true"}, "expandtime": false, "parameters": [ { "param": "graphName", "paramData": [], "value": "packets"}, { "param": "isFluidic", "paramData": [], "value": "true"}, { "paramType": "opmtime", "param": "period", "paramData": [], "value": "Today"} ], "sizey": 13, "timeSelection": true, "desc": "opu.views.PACKETS"}, { "indexCount": 7, "ondemandWidget": false, "refresh": false, "type": "IntfGraphs", "sizex": 10, "expand": false, "apiurl": "/client/api/json/device/getInterfaceGraphs", "rowNum": 25, "parameter": "interfaceName", "isEnabled": true, "colNum": 1, "name": "opm.interface.graphs", "header": true, "id": 10000000088, "snapid": 10000000088, "snapshotData":{ "EE_PROBE_REQ": "true"}, "expandtime": false, "parameters": [ { "param": "graphName", "paramData": [], "value": "errorRate"}, { "param": "isFluidic", "paramData": [], "value": "true"}, { "paramType": "opmtime", "param": "period", "paramData": [], "value": "Today"} ], "sizey": 13, "timeSelection": true, "desc": "webclient.snapshot.name.Error.Rate"}, { "indexCount": 8, "ondemandWidget": false, "refresh": false, "type": "Grid", "sizex": 10, "expand": false, "apiurl": "/client/api/json/device/getInterfaceMonitors", "rowNum": 50, "parameter": "interfaceName", "isEnabled": true, "colNum": 1, "name": "opm.interface.monitors", "header": true, "id": 10000000089, "snapid": 10000000089, "snapshotData":{ "colModelList": [ { "name": "monitorName", "index": "monitorName"}, { "name": "interval", "index": "interval"}, { "name": "collectionTime", "index": "collectionTime"}, { "formatter": "intfValuesWithUnits", "name": "value", "index": "value"}, { "hidden": true, "name": "displayName", "index": "displayName"}, { "hidden": true, "name": "unit", "index": "unit"} ], "colNamesList": [ "webclient.devices.details.monitors", "webclient.map.edit.interval", "webclient.devices.details.lastpoll", "webclient.action.currVal", "", "" ], "EE_PROBE_REQ": "true"}, "expandtime": false, "parameters": [], "sizey": 14, "timeSelection": false, "desc": "webclient.admin.url.monitors"}, { "indexCount": 9, "ondemandWidget": false, "refresh": false, "type": "Grid", "sizex": 10, "expand": false, "apiurl": "/client/api/json/device/getInterfaceMonitors", "rowNum": 50, "parameter": "interfaceName", "isEnabled": true, "colNum": 1, "name": "opm.interface.monitors", "header": true, "id": 10000000971, "snapid": 10000000971, "snapshotData":{ "colModelList": [ { "name": "monitorName", "index": "monitorName"}, { "name": "interval", "index": "interval"}, { "name": "collectionTime", "index": "collectionTime"}, { "formatter": "intfValuesWithUnits", "name": "value", "index": "value"}, { "hidden": true, "name": "displayName", "index": "displayName"}, { "hidden": true, "name": "unit", "index": "unit"} ], "colNamesList": [ "webclient.devices.details.monitors", "webclient.map.edit.interval", "webclient.devices.details.lastpoll", "webclient.action.currVal", "", "" ], "EE_PROBE_REQ": "true"}, "expandtime": false, "parameters": [], "sizey": 14, "timeSelection": false, "desc": "webclient.admin.url.monitors"}, { "indexCount": 10, "ondemandWidget": false, "refresh": false, "type": "Grid", "sizex": 10, "expand": false, "apiurl": "/client/api/json/device/getInterfaceNotes", "rowNum": 64, "parameter": "interfaceName", "isEnabled": true, "colNum": 1, "name": "opm.interface.notes", "header": true, "id": 10000000090, "snapid": 10000000090, "snapshotData":{ "colModelList": [ { "hidden": true, "classes": "GridColHidden", "name": "ALIASNAME", "width": "0", "index": "ALIASNAME", "key": true}, { "hidden": true, "classes": "GridColHidden", "name": "DATATYPE", "width": "0", "index": "DATATYPE", "key": true}, { "formatter": "custField_escapeHtmlTags", "name": "FIELDNAME", "index": "FIELDNAME"}, { "formatter": "custField_escapeHtmlTags", "name": "DESCRIPTION", "index": "DESCRIPTION"}, { "formatter": "custField_escapeHtmlTags", "name": "FIELDVALUE", "index": "FIELDVALUE"} ], "actionurls": [ { "name": "Edit", "url": "InterfaceNotes"} ], "colNamesList": [ "", "", "webclient.devices.customfields.fieldname", "webclient.devices.customfields.description", "webclient.widget.value" ]}, "expandtime": false, "parameters": [], "sizey": 14, "timeSelection": false, "desc": "webclient.commontext.customfields"} ], "snapshotID": "10000000005", "snapshotDesc": "snapshot.desc.Interface", "snapshotName": "OPMInterface", "tabs":{ "tabs": [ { "tabid": 10000000026, "name": "webclient.snapshot.testlinks.summary", "order": 1}, { "tabid": 10000000027, "name": "webclient.snapshot.name.Interface.Graphs", "order": 2}, { "tabid": 10000000028, "name": "webclient.admin.url.monitors", "order": 3} ], "tabWidgets":{ "10000000028": [ { "ROW": 50, "ASSOCIATIONID": 10000000089} ], "10000000027": [ { "ROW": 13, "ASSOCIATIONID": 10000000082}, { "ROW": 15, "ASSOCIATIONID": 10000000083}, { "ROW": 17, "ASSOCIATIONID": 10000000084}, { "ROW": 19, "ASSOCIATIONID": 10000000085}, { "ROW": 21, "ASSOCIATIONID": 10000000086}, { "ROW": 23, "ASSOCIATIONID": 10000000087}, { "ROW": 25, "ASSOCIATIONID": 10000000088} ], "10000000026": [ { "ROW": 1, "ASSOCIATIONID": 10000000081}, { "ROW": 64, "ASSOCIATIONID": 10000000090} ]}}, "timeSelectionNeeded": true, "yScale": 25, "maxColumns": 10}, "ifPhysAddr": "20", "adminState": "Up", "transBandwidth": "1", "statusPolledVia": "SNMP", "outSpeedDisplayValue": "1 bps", "rstime": "1 bps", "availabilityTimeLine": [ "ParentDown,1670178610981,1670233674317", "ParentDown,1670234394000,1670234514150", "UP,1670234514150,1670237050981", "UP,1670233674317,1670234394000" ], "rxPackets": "0.005 ", "ifAdminStatus": "1", "rxUtil": "0.89", "ifSpeedIn": "1", "isAddedToNFA": "false", "Discards": "2", "stringStatus": "Down", "txPackets": "0.002 ", "Errors": "2", "ifSpeedOut": "1", "inTraffic": "0.008 ", "operState": "Up", "intfmanaged": "true", "name": "xxx.xxx.x.xx.10000000001", "typeId": "6", "ifOperStatus": "1", "category": "Switch", "adminStateImg": "", "avgInPackets": "200 ", "status": "2", "desc": "GigabitEthernet1/0/1", "trafficCounter": "32 bit"}

Error Response

View common error responses

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

getDeviceCompleteDetails

Lists the basic details and availability of the device

HTTP Method

GET

API URL

https://localhost:8060/api/json/v2/device/getDeviceCompleteDetails?apiKey=***************&name=devicename

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API Key to access your OpManager server.			Yes
name	Name of the device.	String	Name of the device - Managed Entity name as seen in the URL of device snapshot page OR 'deviceName' property value in the listDevices API response.	Yes

Sample Response

HTTP Code: 200

{ "nfadetails":{ "NFAStatus": "Not Added"}, "statusStr": "Critical", "responseTime": "001ms", "format": "dd-MM-yy HH:mm:ss", "dnsName": "xxx.xxx.xxx.xx", "timeZone": "Asia/Calcutta", "availability": [ "DownTime,1672597848117,1672654248117" ], "todayTimeAvail":{ "todayStartTime": "1672597848132", "endTimeVal": "1672654248132"}, "type": "Cisco 2800 Series", "vendorName": "Cisco", "statusNum": "1", "isStorage": false, "ncmdetails":{ "SUMMARY_NOT_AVAILABLE": true}, "packetLoss": "11", "configBackup":{ "RunningConfig":{}, "StartupConfig":{}}, "opmdetails":{ "Type": "Cisco 2800 Series", "dependentDisplayName": "None", "Category": "Server", "hardwareInfo":{ "HW_MANUFACTURER": "Cisco", "HW_SERIALNUMBER": "FHK1112F402", "IS_ALARM_SUPPRESSED": "false", "ISPDPresent": false, "HW_MODEL": "CISCO2801", "LAST_UPDATED_TIME": "May 10, 2018 05:39 AM", "MOID": 8438, "IS_MONITORED": "true"}, "displayCategory": "Servers", "PollInterval": "7", "IPAddress": "xxx.xxx.xx.xx", "DNSName": "xxx.xxx.xx.xx", "SysDescription": "Cisco IOS Software, 2801 Software (C2801-ADVENTERPRISEK9-M), Version 15.1(3)T1, RELEASE SOFTWARE (fc2)\r\nTechnical Support: http://www.cisco.com/techsupport\r\nCopyright (c) 1986-2011 by Cisco Systems, Inc.\r\nCompiled Sun 27-Mar-11 07:15 by prod_rel_team", "Monitoring": "ICMP", "UpLinkDependency": "None"}, "state": "2", "availdata":{ "Down": 100, "Dependent Unavailable": 0, "On Hold": 0, "Not Monitored": 0, "Parent Down": 0, "On Maintenance": 0, "Up": 0}}

Error Response

View common error responses

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

listVirtualDevices

Retrieves the list of all virtual devices monitored by OpManager based on the selected virtual device type.

HTTP Method

GET

API URL

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

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API Key to access your OpManager server.			Yes
virtualDeviceType	Type of virtual entity which you want to list.	String	Any one of the following - VHOST,VDATASTORE,VM,VCENTER,VxRail,HyperV-Host,HyperV-VM,HyperV-Disk,Xen-Host,Xen-VM,Xen-SR,Xen-Pool,Nutanix-Cluster,Nutanix-Host,Nutanix-VM,VMware-Parent,Proxmox-Node,Proxmox-VM,Proxmox-Container,Proxmox-Cluster	Yes

Sample Response

HTTP Code: 200

{ "VENDOR_NAME": "VMware, Inc.", "BUILD_INFO": "VMware ESXi 6.7.0 build-8169922", "CPU_PACKAGES": 2, "TotalDataStores": 2, "NUM_PNIC": 2, "OS_TYPE": "vmnix-x86", "CPU_MODEL": "Intel(R) Xeon(R) Silver 4114 CPU @ 2.20GHz", "MAINTENANCE_MODE": false, "TotalVms": 11, "VCENTERDISPLAYNAME": "opm-user-vc", "SYSUPTIME": "2021-09-19 21:24:17.745", "CONNECTION_STATUS": "connected", "CPU_THREADS": 40, "CPU_SPEED_MHZ": 2194, "HARDWARE_VENDOR": "Dell Inc.", "NUM_HBA": 3, "CPU_CORES": "20 x 2.20GHz", "LASTUPDATEDTIME": "2023-01-09 17:47:25.159", "MEM_CAPACITY_MB": "127 GB ", "VCENTERNAME": "opm-user-vc.xxx.usercorpin.com", "UUID": "4c4c4544-0047-4b10-8043-c4c04f305432", "HARDWARE_MODEL": "PowerEdge C6420", "ENTITYNAME": "xxx.xx.xxx.xx", "POWER_STATE": "On"}

Error Response

View common error responses

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

Get VMWare Hosts

Retrieves detailed information about VMware ESXi hosts based on the selected entity scope. This API supports fetching host details at either the vCenter level or the VxRail level

HTTP Method

GET

API URL

https://localhost:8060/api/json/device/getVMWareHosts?apiKey=***************&deviceName=vcenter-server

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API Key to access your OpManager server.			Yes
name	Name of the selected entity (vCenter or VxRail)	String	-	Yes
type	Specifies the entity type. Accepted values: VCENTER, VXRAIL	String	Allowed Values: The input must be exactly one of the following — VCENTER,VXRAIL	Yes

Sample Response

HTTP Code: 200

[ { "DISPLAYNAME": "ESXHost-2", "STATUS_STR": "Critical", "NUM_PNIC": 2, "OS": "ESXServer", "OS_TYPE": "vmnix-x86", "SYSUPTIME": "Apr 22, 2023 21:52 PM", "CONNECTION_STATUS": "connected", "NAME": "ESXHost-2", "VHOST_ID": 23703, "STATUS": "1", "CPU_SPEED_MHZ": 2195, "MEM_CAPACITY_MB": 130698, "POWER_STATE": "On"}, { "DISPLAYNAME": "ESXHost-1", "STATUS_STR": "Clear", "NUM_PNIC": 2, "OS": "ESXServer", "OS_TYPE": "vmnix-x86", "SYSUPTIME": "Apr 23, 2023 01:53 AM", "CONNECTION_STATUS": "connected", "NAME": "ESXHost-1", "VHOST_ID": 22505, "STATUS": "5", "CPU_SPEED_MHZ": 2195, "MEM_CAPACITY_MB": 130698, "POWER_STATE": "On"}]

Error Response

View common error responses

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

getDataCenterDetails

Fetches all datacenters associated with a specific vCenter and provides visibility into the vCenter inventory structure.

HTTP Method

GET

API URL

http://localhost:8060/api/json/device/getDataCenterDetails?apiKey=***************&moID=13

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API Key to access your OpManager server.			Yes
moID	Unique ID for vCenter device - 'moID' property value in the getDeviceSummary API response.	long	-	Yes

Sample Response

HTTP Code: 200

[ { "NO_OF_DATASTORES": 5, "STATUS_STR": "Unknown", "STATUS": "7", "NO_OF_NETWORKS": 3, "ENTITY_NAME": "Datacenter"}, { "NO_OF_DATASTORES": 0, "STATUS_STR": "Unknown", "STATUS": "7", "NO_OF_NETWORKS": 0, "ENTITY_NAME": "Datacenter 2"}, { "NO_OF_DATASTORES": 0, "STATUS_STR": "Unknown", "STATUS": "7", "NO_OF_NETWORKS": 0, "ENTITY_NAME": "Datacenter 1"}]

Error Response

View common error responses

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

getClusterDetails

Retrieves the list of all clusters available within a specified vCenter.

HTTP Method

GET

API URL

http://localhost:8060/api/json/device/getClusterDetails?apiKey=***************&moID=13

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API Key to access your OpManager server.			Yes
moID	Unique ID for vCenter device - 'moID' property value in the getDeviceSummary API response.	long	-	Yes

Sample Response

HTTP Code: 200

[ { "NO_OF_DATASTORES": 5, "STATUS_STR": "Clear", "STATUS": "5", "NO_OF_NETWORKS": 2, "EFFECTIVE_CPU": 76780, "NO_OF_HOSTS": 2, "TOTAL_CPU_GHZ": 86, "DRS_ENABLED": false, "DAS_ENABLED": true, "EFFECTIVE_MEMORY": 208229, "ENTITY_NAME": "VSANLab", "TOTAL_MEMORY_GB": 255}]

Error Response

View common error responses

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

getVMWareVMs

Retrieves detailed information about VMware virtual machines based on the selected managed entity. This API supports fetching VM details at multiple levels including vCenter, Host, Datastore, and VxRail.

HTTP Method

GET

API URL

https://localhost:8060/api/json/device/getVMWareVMs?apiKey=***************&deviceName=vcenter-server

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API Key to access your OpManager server.			Yes
name	Name of the selected entity (vCenter, Host, DATASTORE, or VxRail)	String	-	Yes
type	Specifies the entity type. Accepted values: VCENTER, HOST, DATASTORE, VXRAIL	String	Any one of the values - VCENTER,HOST,DATASTORE,VXRAIL	No

Sample Response

HTTP Code: 200

[ { "VM_CONNECTIONSTATE": "connected", "DISPLAYNAME": "VMware-vm1", "VM_ID": 33002, "VIRTUAL_TYPE": "VMware-VM", "NUM_ETHERNET": 1, "VM_POWERSTATE": "Off", "OS_NAME": "CentOS 4/5 or later (32-bit)", "NUM_VDISK": 1, "VHOST_ID": 22505, "MEMORY_MB": 1024, "MOID": -4, "IS_ORPHANED": "false", "NUM_VCPU": 1}, { "VM_CONNECTIONSTATE": "connected", "DISPLAYNAME": "VMware-VM2", "STATUS_STR": "Trouble", "VM_ID": 23716, "VIRTUAL_TYPE": "VMware-VM", "NUM_ETHERNET": 1, "VM_POWERSTATE": "On", "MAX_CPU_MHZ": 17560, "IPADDRESS": "172.24.141.242", "OS_NAME": "Microsoft Windows Server 2016 (64-bit)", "NUM_VDISK": 1, "NAME": "VMware-VM-3", "VHOST_ID": 23703, "MEMORY_MB": 16384, "STATUS": "2", "MOID": 27302, "MAX_MEMORY_MB": 16384, "IS_ORPHANED": "false", "NUM_VCPU": 8}]

Error Response

View common error responses

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

getVMWareDataStores

Retrieves detailed information about VMware datastores based on the selected entity type.

This API supports fetching datastore details at multiple levels, including vCenter, Host, Virtual Machine, and VxRail, providing flexible storage visibility across the VMware environment.

HTTP Method

GET

API URL

https://localhost:8060/api/json/device/getVMWareDataStores?apiKey=***************&deviceName=vcenter-server

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API Key to access your OpManager server.			Yes
name	Name of the selected entity (vCenter, Host, VM, or VxRail)	String	-	Yes
type	Specifies the entity type. Accepted values: VCENTER, HOST, VM, VXRAIL	String	Allowed Values: The input must be exactly one of the following — VCENTER,HOST,VM,VXRAIL	No

Sample Response

HTTP Code: 200

[ { "HostCount": 1, "DATASTORENAME": "VMDatastorage (1)", "Datastore_ID": 23719, "FILESYSTEM_TYPE": "VMFS", "CAPACITY_MB": 3224, "DATASTORE_URL": "ds:///vmfs/volumes/442ec0fc-67dad2ec-386f-b496913ce490/", "MOID": 48373, "FREESPACE_MB": 615, "deviceName": "device1_com_datastore-1923", "IS_ACCESSIBLE": "5"}, { "HostCount": 1, "DATASTORENAME": "VMFSdatastore (3)", "Datastore_ID": 23718, "FILESYSTEM_TYPE": "VMFS", "CAPACITY_MB": 492, "DATASTORE_URL": "ds:///vmfs/volumes/342ebecc-2b289b6a-dd6e-b496913ce490/", "MOID": 48372, "FREESPACE_MB": 427, "deviceName": "device2_datastore-1922", "IS_ACCESSIBLE": "5"}, { "HostCount": 2, "DATASTORENAME": "VSANDatastore", "Datastore_ID": 32101, "FILESYSTEM_TYPE": "vsan", "CAPACITY_MB": 1862, "DATASTORE_URL": "ds:///vmfs/volumes/vsan:56f4a7b4df993895-66fa8c0ed80efd32/", "MOID": 61801, "FREESPACE_MB": 1840, "deviceName": "device3_datastore-2718", "IS_ACCESSIBLE": "5"}]

Error Response

View common error responses

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

getNutanixVDisks

Retrieves information about virtual disks in the Nutanix cluster

HTTP Method

GET

API URL

https://localhost:8060/api/json/device/getNutanixVDisks?apiKey=***************&deviceName=nutanix-cluster

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API Key to access your OpManager server.			Yes
name	Name of the selected Nutanix Virtual Machine managed entity name as seen in the URL of device snapshot page OR 'deviceName' property value in the listDevices API response.	String	-	Yes

Sample Response

HTTP Code: 200

[ { "CAPACITY": "150", "NFSFILEPATH": "/General/.acropolis/vmdisk/343e6469-b11d-e321-b30a-1598371a20f8", "VDISK_ID": 1, "DISKADDRESS": "scsi.0", "UUID": "343e6469-b11d-e321-b30a-1598371a20f8"}]

Error Response

View common error responses

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

getNutanixDetails

This API fetches detailed information about Nutanix infrastructure components based on the specified entity type. This API supports fetching details for Nutanix virtual machines, hosts, or clusters, providing detailed visibility into the Nutanix environment.

HTTP Method

GET

API URL

https://localhost:8060/api/json/device/getNutanixDetails?apiKey=***************&deviceName=nutanix-cluster

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API Key to access your OpManager server.			Yes
deviceName	Name of the device	String	-	Yes
entityType	Specifies the Nutanix entity type. Accepted values: Nutanix-VM, Nutanix-Host, Nutanix-Cluster	String	Allowed Values: The input must be exactly one of the following — Nutanix-Cluster,Nutanix-Host,Nutanix-VM.	Yes

Sample Response

HTTP Code: 200

{ "DISPLAYNAME": "NutanixVM2", "clusterMoName": "Nutanix-Cluster-1", "hostName": "Nutanix-Host-1", "VCPUCOUNT": 2, "VM_ID": 21, "statusStr": "Clear", "TOOLSMOUNTED": false, "TOOLSVERSION": "1.2.0.3", "VM_POWERSTATE": "Powered On", "DISKCAPACITY": "150", "IPADDRESS": "172.24.151.114", "uuid": "3af940cd-b453-485d-89ab-2cab95aba188", "deviceName": "Nutanix-VM-1", "MEMORYCAPACITY": "6", "statusNum": 5, "ISCONTROLLERVM": "False", "STATUS": "\u00a0Clear", "NOOFNETWORKADAPTERS": 1, "clusterName": "Nutanix-Cluster-1", "hostMoName": "Nutanix-Host-1", "MOID": 307, "MEMRESERVEDCAPACITY": "6", "ENTITYNAME": "Nutanix-VM-2"}

Error Response

View common error responses

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

addVxRailTovCenter

This API is used to register a VxRail system and associate it with a specific vCenter instance, thereby enabling centralized management.

HTTP Method

POST

API URL

https://localhost:8060/api/json/device/addVxRailTovCenter?apiKey=***************&deviceName=xxx.xxx.xx.x

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API Key to access your OpManager server.			Yes
deviceName	vCenter name to which the VxRail will be added. Click here to learn how to get the vCenter MO Name	String	Allowed characters: one or more of Unicode letters (any language), Unicode numbers, hyphen (-), period (.), underscore (_), plus sign (+), at sign (@), dollar sign ($), and whitespace characters	Yes
vxrailDeviceName	Device name of the VxRail to be added to the vCenter.	String	-	Yes
vxrailCredentialName	Credential name of the VxRail device --> Credential profile to be used for discovering VxRail device.	String	-	Yes

Sample Response

HTTP Code: 200

{ "result":{ "message": "VxRail inventory discovery in progress."}}

Error Response

View common error responses

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

EditPerformanceMonitor

Updating the Performance monitor

HTTP Method

POST

API URL

https://localhost:8060/api/json/device/EditPerformanceMonitor?apiKey=***************&name=123&policyName=WMIAvgDiskLatency&pollId=28655&displayName=Average+Disk+Latency&thresholdName=&type=node&timeAvg=&vendor=&sendClear=true&oid=WMI+Average+Disk+Latency&interval=15&yaxisText=MilliSeconds&checkNumeric=true

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API Key to access your OpManager server.			Yes
name	Name of the device	String	-	Yes
name	Name of the device	String	-	Yes
policyName	Policy name of the performance monitor	String	GraphAndPolicyName:: value="^([^\*\^<>+,{}])+$"	Yes
graphName	Graph name of the performance monitor.	String	GraphAndPolicyName:: value="^([^\*\^<>+,{}])+$"	Yes
pollId	Pollid of the performance monitor.	long	-	No
displayName	DisplayName of the performance monitor.	String	-	No
thresholdName	ThreadName of the performance monitor.	String	Accepts any character except asterisk (*), caret (^), less-than (<), greater-than (>), plus (+), comma (,), curly braces ({}), with at least one character required.	No
type	type of the monitor.	String(interface\|multiple\|multiplenode\|node)	Allowed Values: Any one of the following - interface, multiple,multiplenode,node	No
timeAvg	timeAvg of the monitor.	String(true\|false)	Allowed Values: The input must exactly match either true or false.	No
vendor	vendor of the monitor.	String	Allowed Characters: Unicode letters, numbers, hyphen (-), parentheses (()), dot (.), comma (,), underscore (_), forward slash (/), and whitespace characters.	No
sendClear	SendClear of the monitor.	Boolean	Allowed Values: The input must exactly match either true or false	No
oid	oid of the monitor.	String	-	No
interval	interval of the monitor.	int	range 1-1440	No
yaxisText	yaxisText of the monitor.	String	Allowed Characters: Any characters except less than (<) and greater than (>) symbols.	No
failureThreshold	Consecutive time of the monitor.	int	=0	No
oidType	oid type of the monitor.	String	-	No
firstTime	For Update monitor, it should be false	Boolean	false	No
thresholdEnabled	Threshold should be Enabled or not.	Boolean	Allowed Values: The input must exactly match either true or false	No
perfDataStoreType	Data should be stored or not	int	-	No
instanceName	Instance Name of the monitor.	String	-	No
isGraphNeeded		Boolean	Allowed Values: The input must exactly match either true or false	No
warningThresholdType	Threshold type of the warning severity of the Integer monitor	String	Allowed Values: Any one of - min,max,equal,notEqual	No
warningThresholdTextualType	Threshold type of the warning severity of the String monitor	String	Allowed Values: Any one of - Contains,Equals,Not Contains,Not Equals,Regex	No
warningThresholdTextValue	Threshold Value of the warning severity of the String monitor	String	-	No
warningMessage	Threshold Value of the warning severity of the int monitor	String	-	No
troubleThresholdType	Threshold Value of the warning severity of the integer monitor	String	Allowed Values: Any one of - min, max, equal,notEqual	No
troubleThresholdTextualType	Threshold Type of the warning severity of the String monitor	String	Allowed Values: Any one of - Contains,Equals,Not Contains,Not Equals,Regex	No
troubleThresholdTextValue	Threshold Type of the trouble severity of the String monitor	String	Allowed Values: Any one of - Contains,Equals,Not Contains,Not Equals,Regex	No
troubleMessage	Threshold Message of the trouble severity of the int monitor	String	-	No
criticalThresholdType	Threshold Value of the critical severity of the integer monitor	String	Allowed Values: Any one of - min, max, equal,notEqual	No
criticalThresholdTextualType	Threshold condition of the critical severity of the String monitor	String	Allowed Values: Any one of - Contains,Equals,Not Contains,Not Equals,Regex	No
criticalThresholdTextValue	Threshold Value of the critical severity of the String monitor	String	-	No
criticalMessage	Threshold Message of the Critical severity of the int monitor	String	-	No
upperlimitThresholdType	Threshold Type of the Upper limit of the Adaptive threshold	String	Allowed Values: max or min	No
upperlimitThresholdTextualType	Threshold Type of the Upper limit of the Adaptive threshold	String	Allowed Values: Any one of the following - max,equal,min,notEqual,Contains,Equals,Not Contains,Not Equals,Regex	No
upperlimitThresholdTextValue	Threshold Value of the Upper limit of the Adaptive threshold	double	Allowed Values: Any one of the following - max,equal,min,notEqual,Contains,Equals,Not Contains,Not Equals,Regex	No
upperlimitMessage	Threshold Message of the Upper limit of the Adaptive threshold	String	Allowed Characters: Unicode letters, numbers, characters outside the Basic Latin range (supports two-byte characters like Chinese, Japanese, etc.), parentheses (()), hyphen (-), underscore (_), dot (.), exclamation (!), percent (%), colon (:), at (@), dollar ($), and whitespace characters.	No
upperlimitSeverity	Threshold Severity of the Upper limit of the Adaptive threshold	int	range="1-7"	No
lowerlimitThresholdType	Threshold Type of the lower limit of the Adaptive threshold	String	Allowed Values: max or min	No
lowerlimitThresholdTextualType	Threshold Type of the lower limit of the Adaptive threshold	String	Allowed Values: Any one of the following - max,equal,min,notEqual,Contains,Equals,Not Contains,Not Equals,Regex	No
lowerlimitThresholdTextValue	Threshold Value of the lower limit of the Adaptive threshold	double	Allowed Values: Any one of the following - max,equal,min,notEqual,Contains,Equals,Not Contains,Not Equals,Regex	No
clearThresholdType	To clear alert the Threshold Type	String	Allowed Values: Any one of - min, max, equal,notEqual	No
rearmTextualType	To clear alert the Threshold Type of String	String	Allowed Values: Any one of - Contains,Equals,Not Contains,Not Equals,Regex	No
rearmTextValue	Rearm text value	String	-	No
clrMessage	clear message of the monitor	String	-	No
adStoreFilePath	ad Store file path	String	Does not allow sequences like ../, ..\, \\, //, <, >, or any value ending with ..	No
xchgStoreLocation	Xchng Store Location	String	Accepts filenames ending with .edb or .stm that do not contain sequences like ../, ..\, \\, //, <, >, and do not end with ..	No
minInterval	Min interval	int	=0	No
isMultipleThreshold	is multiple threshold	Boolean/	Allowed Values: The input must exactly match either true or false	No
downSeverity	Down Severity	int/	^(1\|2\|3\|4\|6)	No
downConsecutiveTime	Consecutive time of the service monitor	int/	^(1\|2\|3\|4\|6)	No
downConsecutiveTime	Consecutive time of the service monitor	int/	^(1\|2\|3\|4\|6)	No
warningThresholdValue	Threshold value of the warning severity of the monitor	double/	-	No
troubleThresholdValue	Threshold value of the trouble severity of the monitor	double/	-	No
criticalThresholdValue	Threshold value of the critical severity of the monitor	double/	-	No
lowerlimitThresholdValue	lower limit of the Threshold value of the adapative threshold	double/	-	No
upperlimitThresholdValue	upper limit of the Threshold value of the adapative threshold	double/	-	No
rearmValue	rearm of the Threshold value of the monitor	double/	-	No
isAdaptiveThresholdsEnabled	adative threshold is enable	Boolean/	Allowed Values: The input must exactly match either true or false	No
deviationType	adaptive threshold is deviation type	int/	Allowed Values: The input must be exactly either 1 or 2	No

Sample Response

HTTP Code: 200

{"result":{"message":"Successfully modified the graph"}}

Error Response

View common error responses

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

fetchMonitorsList

For getting the monitors of a devices

HTTP Method

POST

API URL

https://localhost:8060/api/json/device/fetchMonitorsList?apiKey=***************&deviceList=xyz,21.21.21.21,yyy

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API Key to access your OpManager server.			Yes
deviceList	Device List with comma separated	String	-	No
groupMOID	Virtual Type	long	GroupID for getting the monitors of a group	No
isAvailabilityView	If require only Availability, Response Time etc monitors	Boolean	Allowed Values: The input must exactly match either true or false	No

Sample Response

HTTP Code: 200

[ { "policyName": "DevicesAvailability", "monitorName": "Devices Availability"}, { "policyName": "Packet_Loss", "monitorName": "Packet Loss"}, { "policyName": "ResponseTime", "monitorName": "Response Time"}]

Error Response

View common error responses

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

getAssociatedMonitors

The API returns a complete list of monitors associated with the device, including performance monitors, application monitors, Windows services, and scripts, along with their last polled values and status.

Note: If you're looking for performance monitor details alone, we recommend using the getLastCollectedValues API, which is more efficient and returns the last collected values of the monitors along with other properties.

HTTP Method

GET

API URL

https://localhost:8060/api/json/device/getAssociatedMonitors?apiKey=***************&name=***

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API Key to access your OpManager server.			Yes
name	Click here to learn how to get the Device Name.	String	-	Yes

Sample Response

HTTP Code: 200

{ "performanceMonitors":{ "total": 9, "down": 1, "monitors": [ { "DISPLAYNAME": "CPU Utilization", "checkNumeric": "true", "graphType": "multiple", "Instance": "", "policyName": "WMI-CPUUtilization", "THRESHOLDENABLED": "true", "GRAPHID": "203", "active": "false", "thresholdStatus": "Violated", "isMultiple": "true", "type": "multiple", "thresholdImg": "images/thresholdConTrouble.gif", "groupName": "WMI", "DisplayColumn": "", "name": "WMI-CPUUtilization", "interval": "8", "numericType": "1", "id": "22905", "Id": "22905", "Protocol": "WMI"}, { "DISPLAYNAME": "Used Disk Space in GB-C:", "checkNumeric": "true", "graphType": "multiplenode", "Instance": "", "policyName": "WMI-UsedDiskSpaceInGB", "THRESHOLDENABLED": "false", "GRAPHID": "303", "active": "false", "thresholdStatus": "Not Enabled", "isMultiple": "false", "type": "node", "thresholdImg": "images/thresholdNonConfigured.gif", "groupName": "WMI", "DisplayColumn": "", "name": "C:", "interval": "15", "numericType": "1", "id": "22900", "Id": "22900", "Protocol": "WMI"}, { "DISPLAYNAME": "Memory Utilization", "checkNumeric": "true", "graphType": "multiple", "Instance": "", "policyName": "WMI-MemoryUtilization", "THRESHOLDENABLED": "true", "GRAPHID": "204", "active": "false", "thresholdStatus": "Normal", "isMultiple": "true", "type": "multiple", "thresholdImg": "images/thresholdConOK.gif", "groupName": "WMI", "DisplayColumn": "", "name": "WMI-MemoryUtilization", "interval": "15", "numericType": "1", "id": "22906", "Id": "22906", "Protocol": "WMI"}, { "DISPLAYNAME": "Free Disk Space in GB-C:", "checkNumeric": "true", "graphType": "multiplenode", "Instance": "", "policyName": "WMI-FreeDiskSpaceInGB", "THRESHOLDENABLED": "false", "GRAPHID": "301", "active": "false", "thresholdStatus": "Not Enabled", "isMultiple": "false", "type": "node", "thresholdImg": "images/thresholdNonConfigured.gif", "groupName": "WMI", "DisplayColumn": "", "name": "C:", "interval": "15", "numericType": "1", "id": "22899", "Id": "22899", "Protocol": "WMI"}, { "DISPLAYNAME": "System UpTime in minutes", "checkNumeric": "true", "graphType": "node", "Instance": "", "policyName": "WMISystemUpTime", "THRESHOLDENABLED": "false", "GRAPHID": "3654", "active": "false", "thresholdStatus": "Not Enabled", "isMultiple": "false", "type": "node", "thresholdImg": "images/thresholdNonConfigured.gif", "groupName": "WMI", "DisplayColumn": "", "name": "WMISystemUpTime", "interval": "15", "numericType": "1", "id": "22908", "Id": "22908", "Protocol": "WMI"}, { "DISPLAYNAME": "Partition Details of the Device(%)-C:", "checkNumeric": "true", "graphType": "multiplenode", "Instance": "", "policyName": "WMI-PartitionDetails", "THRESHOLDENABLED": "false", "GRAPHID": "304", "active": "false", "thresholdStatus": "Not Enabled", "isMultiple": "false", "type": "node", "thresholdImg": "images/thresholdNonConfigured.gif", "groupName": "WMI", "DisplayColumn": "", "name": "C:", "interval": "15", "numericType": "1", "id": "22904", "Id": "22904", "Protocol": "WMI"}, { "DISPLAYNAME": "Free Megabytes.C:", "checkNumeric": "true", "graphType": "node", "Instance": "", "policyName": "LogicalDisk.FreeMegabytes.C_", "THRESHOLDENABLED": "false", "GRAPHID": "5676", "active": "false", "thresholdStatus": "Not Enabled", "isMultiple": "false", "type": "node", "thresholdImg": "images/thresholdNonConfigured.gif", "groupName": "WMI", "DisplayColumn": "", "name": "LogicalDisk.FreeMegabytes.C_", "interval": "3", "numericType": "1", "id": "22902", "Id": "22902", "Protocol": "WMI"}, { "DISPLAYNAME": "Processes.", "checkNumeric": "true", "graphType": "node", "Instance": "", "policyName": "System.Processes.", "THRESHOLDENABLED": "false", "GRAPHID": "7599", "active": "false", "thresholdStatus": "Not Enabled", "isMultiple": "false", "type": "node", "thresholdImg": "images/thresholdNonConfigured.gif", "groupName": "WMI", "DisplayColumn": "", "name": "System.Processes.", "interval": "2", "numericType": "1", "id": "24341", "Id": "24341", "Protocol": "WMI"}, { "DISPLAYNAME": "IO Read and Write Rate", "checkNumeric": "true", "graphType": "node", "Instance": "", "policyName": "WMIIOReadandWriteRate", "THRESHOLDENABLED": "false", "GRAPHID": "3642", "active": "false", "thresholdStatus": "Not Enabled", "isMultiple": "false", "type": "node", "thresholdImg": "images/thresholdNonConfigured.gif", "groupName": "WMI", "DisplayColumn": "", "name": "WMIIOReadandWriteRate", "interval": "15", "numericType": "1", "id": "22907", "Id": "22907", "Protocol": "WMI"} ]}, "serverMonitors":{ "total": 5, "down": 5, "monitors": [ { "portNo": "25", "failureThreshold": 1, "statusText": "webclient.devices.intftypes.down", "name": "SMTP", "status": "images/servicestatus7.gif"}, { "portNo": "343", "failureThreshold": 1, "statusText": "webclient.devices.intftypes.down", "name": "TestMo", "status": "images/servicestatus7.gif"}, { "portNo": "80", "failureThreshold": 1, "statusText": "webclient.devices.intftypes.down", "name": "Web", "status": "images/servicestatus7.gif"}, { "portNo": "135", "failureThreshold": 1, "statusText": "webclient.devices.intftypes.down", "name": "135", "status": "images/servicestatus7.gif"}, { "portNo": "53", "failureThreshold": 3, "statusText": "webclient.devices.intftypes.down", "name": "DNS", "status": "images/servicestatus7.gif"} ]}, "ntServiceMonitors":{ "total": 4, "down": 4, "monitors": [ { "name": "Device Association Service", "serviceName": "DeviceAssociationService", "moid": "81369", "status": "/images/devices/status7.gif"}, { "name": "ManageEngine OpManager Agent", "serviceName": "ManageEngine OpManager Agent", "moid": "103553", "status": "/images/devices/status7.gif"}, { "name": "Print Spooler", "serviceName": "Spooler", "moid": "89263", "status": "/images/devices/status7.gif"}, { "name": "RPC", "serviceName": "RpcSs", "moid": "81368", "status": "/images/devices/status7.gif"} ]}, "urlMonitors":{ "total": 0, "down": 0, "monitors": [ ]}, "processMonitors":{ "total": 5, "down": 5, "monitors": [ { "isSuppressed": "false", "statusStr": "Unknown", "statusIcon": "/webclient/devices/images/servicestatus7.gif", "trimName": "csrss.exe", "statusNum": "7", "path": "-", "suppressedMessage": "", "cmdLineArgs": "", "name": "csrss.exe", "id": "81371", "proName": "csrss.exe", "state": "7", "status": "7"}, { "isSuppressed": "false", "statusStr": "Unknown", "statusIcon": "/webclient/devices/images/servicestatus7.gif", "trimName": "MonitoringAgent.e...", "statusNum": "7", "path": "C:\\Program Files (x86)\\ManageEngine\\OpManagerAgent\\monitoring\\bin\\", "suppressedMessage": "", "cmdLineArgs": "", "name": "MonitoringAgent.exe SNMP", "id": "103604", "proName": "MonitoringAgent.exe", "state": "7", "status": "7"}, { "isSuppressed": "false", "statusStr": "Unknown", "statusIcon": "/webclient/devices/images/servicestatus7.gif", "trimName": "MonitoringAgent.e...", "statusNum": "7", "path": "C:\\Program Files (x86)\\ManageEngine\\OpManagerAgent\\monitoring\\bin\\MonitoringAgent.exe", "suppressedMessage": "", "cmdLineArgs": "\"C:\\Program Files (x86)\\ManageEngine\\OpManagerAgent\\\\monitoring\\bin\\MonitoringAgent.exe\"", "name": "MonitoringAgent.exe WMI", "id": "103718", "proName": "MonitoringAgent.exe", "state": "7", "status": "7"}, { "isSuppressed": "false", "statusStr": "Unknown", "statusIcon": "/webclient/devices/images/servicestatus7.gif", "trimName": "MSSQL", "statusNum": "7", "path": "C:\\Program Files\\Microsoft SQL Server\\MSSQL\\Binn\\sqlservr.exe", "suppressedMessage": "", "cmdLineArgs": "", "name": "MSSQL", "id": "81370", "proName": "sqlservr.exe", "state": "7", "status": "7"} ]}, "fileMonitors":{ "total": 2, "down": 0, "monitors": [ { "suppressedMessage": "", "filemonitorid": "23069", "monitorname": "sdfghjk", "filepath": "c:/t.txt", "isSuppressed": "false", "statusStr": "Clear", "statusIcon": "/webclient/devices/images/servicestatus5.gif", "state": "4", "status": "5", "statusNum": 5}, { "suppressedMessage": "", "filemonitorid": "23070", "monitorname": "TestFileeTemp", "filepath": "C:\\Test.txt", "isSuppressed": "false", "statusStr": "Clear", "statusIcon": "/webclient/devices/images/servicestatus5.gif", "state": "4", "status": "5", "statusNum": 5} ]}, "eventlogMonitors":{ "period": "300", "total": 3, "isActive": "true", "down": 0, "monitors": [ { "ruleName": "Any windows powershell failure", "id": "58"}, { "ruleName": "Eventlog Service stopped", "id": "29"}, { "ruleName": "DCOM10036", "id": "70"} ]}, "folderMonitors":{ "total": 0, "down": 0, "monitors": [ ]}, "scriptMonitors":{ "total": 1, "down": 1, "monitors": [ { "displayName": "Certificate Expiry Monitor", "pollid": "24728", "thresholdSeverity": "Violated", "statusIcon": "images/servicestatus5.gif", "interval": "15", "thresholdSevFont": "#ff6600", "OID": "33611"} ]}}

Error Response

View common error responses

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

getDeviceAssociatedProcessMonitors

The API provides a complete list of Process Monitors associated with the device, including details such as process path, arguments, and status.

HTTP Method

GET

API URL

https://localhost:8060/api/json/device/getDeviceAssociatedProcessMonitors?apiKey=***************&name=devicename

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API Key to access your OpManager server.	String	-	Yes
name	Click here to learn how to get the Device Name.	String	-	Yes

Sample Response

HTTP Code: 200

[ {'path':'/usr/sbin/writesrv','processName':'writesrv','displayName':'writesrv','cmdLineArgs':'','status':'Clear'}]

Error Response

View common error responses

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

getDeviceAssociatedServiceMonitors

The API provides a complete list of Service monitors linked to the device, including details such as name, port, and status.

HTTP Method

GET

API URL

https://localhost:8060/api/json/device/getDeviceAssociatedServiceMonitors?apiKey=***************&name=devicename

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API Key to access your OpManager server.	String	-	Yes
name	Click here to learn how to get the Device Name.	String	-	Yes

Sample Response

HTTP Code: 200

[ { "name": "DNS", "portNo": "80", "status": "Clear",}]

Error Response

View common error responses

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

getGraphData

Retrieves graph data for device performance metrics

HTTP Method

GET

API URL

https://localhost:8060/api/json/device/getGraphData?apiKey=***************&deviceName=devicename&graphName=cpu

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API Key to access your OpManager server.			Yes
name	Device Name/Any other type of the graph	String	-	Yes
parentObj	ParentObj for the few category	String	-	No
policyName	policyName of the Monitor	String	-	No
index	index of the Monitor	String	-	No
period	Period to select for the graph	String	Allowed Values: Any one of the following - custom,Today,onehour,twohours,fourhours,sixhours,eighthours,twelvehours,twfourhours,before_12_hours,before_24_hours,before_48_hours,Last_7_Days,WEEK,Last_30_Days,MONTH,Last_60_Days,Last_90_Days,Yesterday,thisweek,lastweek,thismonth,Last_Month,Last 12 hours,Last 24 hours,Last 7 days,This week,Last week,This month,Last month,Last 30 days,last_7_days,last_30_days,last_90_days,Last_12_hours,Last_24_hours,This_Week,This_Month,Last_Week,Next_7_days,Next_14_days,Next_30_days,Next_60_days,Next_90_days,Next_12_hours,Next_24_hours,This_Week,This_Quarter,Last_Quarter,Last_3_Months,Last_6_Months	No
instance	instance of the monitor	String	-	No
isHardwareGraph	For Hardware Graph	Boolean	Allowed Values: The input must exactly match either true or false	No
parameterName	Type of the parameter for Hardware	String	-	No
withMMA	If require the Min, Max,Avg & 95th percentile value in consolidated values	Boolean	Allowed Values: The input must exactly match either true or false	No
startDate	Start Date for the graph	String	Ex:- 08/10/2025 00:00 Regex dateFormat:: ^([0][1-9]\|[1\|2]\d\|[3][0\|1])\/([0][1-9]\|[1][0-2])\/\d{4}\s([0-1]\d\|[2][0-3])\:[0-5]\d$	No
endDate	End Date for the graph	String	Ex:- 14/10/2025 19:24 Regex dateFormat:: ^([0][1-9]\|[1\|2]\d\|[3][0\|1])\/([0][1-9]\|[1][0-2])\/\d{4}\s([0-1]\d\|[2][0-3])\:[0-5]\d$	No
instanceName	Instance Name	String	-	No
graphFilterType	Type of the data(For Archive Data) for plotting the graph	String	Allowed Values: The input must be exactly one of the following — min, max, or avg	No

Sample Response

HTTP Code: 200

{ "graphData":{ "timestamps": ["2025-01-15 10:00", "2025-01-15 11:00"], "values": [45.2, 52.8], "unit": "%", "graphName": "CPU Utilization"}}

Error Response

View common error responses

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

getGraphNames

The API will return a complete set of performance monitors associated with the device, including properties such as displayName, pollId, policyName, name, protocol, OID, and graphType.

HTTP Method

GET

API URL

https://localhost:8060/api/json/device/getGraphNames?apiKey=***************&name=devicename

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API Key to access your OpManager server.	String	-	Yes
name	Click here to learn how to get the Device Name.	String	-	Yes

Sample Response

HTTP Code: 200

[ { "protocol": "WMI", "graphType": "multiple", "policyName": "WMI-MemoryUtilization", "displayName": "Memory Utilization", "pollId": "28650", "name": "WMI-MemoryUtilization", "oid": "Memory Utilization"}, { "protocol": "WMI", "graphType": "node", "policyName": "WMIIOReadandWriteRate", "displayName": "IO Read and Write Rate", "pollId": "28654", "name": "WMIIOReadandWriteRate", "oid": "WMI IO Read and Write Rate"}, { "protocol": "WMI", "graphType": "node", "policyName": "WMISystemUpTime", "displayName": "System UpTime in minutes", "pollId": "28656", "name": "WMISystemUpTime", "oid": "WMI System UpTime"}, { "protocol": "WMI", "graphType": "node", "policyName": "WMIAvgDiskLatency", "displayName": "Average Disk Latency", "pollId": "28655", "name": "WMIAvgDiskLatency", "oid": "WMI Average Disk Latency"}, { "protocol": "WMI", "graphType": "multiplenode", "policyName": "WMI-PartitionDetails", "displayName": "Partition Details of the Device(%)-C:", "pollId": "28653", "name": "C:", "oid": "Partition Details of the Device"}, { "protocol": "WMI", "graphType": "multiple", "policyName": "WMI-DiskUtilization", "displayName": "Disk Utilization", "pollId": "28651", "name": "WMI-DiskUtilization", "oid": "Disk Utilization"}, { "protocol": "WMI", "graphType": "multiple", "policyName": "WMI-CPUUtilization", "displayName": "CPU Utilization", "pollId": "28649", "name": "WMI-CPUUtilization", "oid": "CPU Utilization ProcessorInformation"}]

Error Response

View common error responses

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

Get Nutanix Disks

Retrieves detailed information about disks within the Nutanix environment. Based on the specified entity type, this API returns disk-level details at either the cluster level or the host level.

HTTP Method

GET

API URL

https://localhost:8060/api/json/device/getNutanixDisks?apiKey=**************&deviceName=*****&type=nutanix-cluster

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API Key to access your OpManager server.			Yes
name	Click here to learn how to get the Device Name.	String	-	Yes
type	Entity Type like Nutanix-Cluster\|Nutanix-Host	String	Allowed Values: The input must be exactly one of the following — Nutanix-Cluster, Nutanix-Host",	Yes

Sample Response

HTTP Code: 200

[ { "CAPACITY": "3330.52", "STATUS": "NORMAL", "DISK_ID": 36, "SERIALNUMBER": "local123", "USAGE": "741.21", "TIER": "SSD", "MOUNTPATH": "/home/nutanix/data/stargate-storage/disks/local123"}, { "CAPACITY": "3119.15", "STATUS": "NORMAL", "DISK_ID": 37, "SERIALNUMBER": "local124", "USAGE": "721.32", "TIER": "SSD", "MOUNTPATH": "/home/nutanix/data/stargate-storage/disks/local124"}, { "CAPACITY": "3330.52", "STATUS": "NORMAL", "DISK_ID": 38, "SERIALNUMBER": "local125", "USAGE": "743.49", "TIER": "SSD", "MOUNTPATH": "/home/nutanix/data/stargate-storage/disks/local125"}, { "CAPACITY": "3330.52", "STATUS": "NORMAL", "DISK_ID": 39, "SERIALNUMBER": "local126", "USAGE": "741.62", "TIER": "SSD", "MOUNTPATH": "/home/nutanix/data/stargate-storage/disks/local126"}, { "CAPACITY": "3119.15", "STATUS": "NORMAL", "DISK_ID": 40, "SERIALNUMBER": "local126", "USAGE": "721.46", "TIER": "SSD", "BOOTDISK": true, "MOUNTED": true, "VENDOR": "Not Available", "MODEL": "SAMSUNG -00005", "MOUNTPATH": "/home/nutanix/data/stargate-storage/disks/local126"}, { "CAPACITY": "3330.52", "STATUS": "NORMAL", "DISK_ID": 35, "SERIALNUMBER": "local127", "USAGE": "743", "TIER": "SSD", "BOOTDISK": false, "MOUNTED": true, "VENDOR": "Not Available", "MODEL": "SAMSUNG -00005", "MOUNTPATH": "/home/nutanix/data/stargate-storage/disks/local127"}]

Error Response

View common error responses

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

Get Nutanix Hosts

Retrieves detailed information about all hosts within a specified Nutanix cluster. This API provides visibility into host-level resources, health, and operational status

HTTP Method

GET

API URL

https://localhost:8060/api/json/device/getNutanixHosts?apiKey=***************&deviceName=nutanix-cluster

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API Key to access your OpManager server.	String	-	Yes
deviceName	Click here to learn how to get the Device Name.	String	-	Yes

Sample Response

HTTP Code: 200

[ { "DISPLAYNAME": "opm-NutanixHost1", "statusStr": "Critical", "DISKCAPACITY": "19560.36", "IPADDRESS": "172.172.172.172", "HYPERVISORDETAIL": "Nutanix 20170830.265", "CPUMODEL": "Intel(R) Xeon(R) Gold 6138 CPU @ 2.00GHz", "MEMORYCAPACITY": "503.49", "statusNum": 1, "NAME": "opm-dev2.csez.zohocorpin.com", "BOOTTIME": "2019-05-27 20:48:24.153", "SELECTIONSTATE": 1, "NUMCPUCORES": 40, "HOST_ID": 21, "TYPE": "kKvm"}]

Error Response

View common error responses

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

getNutanixOrphanedVMs

Retrieves detailed information about orphaned virtual machines within the Nutanix environment. Orphaned VMs are virtual machines that exist in storage but are no longer properly associated with an active host or cluster.

HTTP Method

GET

API URL

https://localhost:8060/api/json/device/getNutanixOrphanedVMs?apiKey=***************&deviceName=nutanix-cluster

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API Key to access your OpManager server.			Yes
name	Click here to learn how to get the Device Name.	String	-	Yes
type	Specifies the entity type. Accepted values: Nutanix-Cluster, Nutanix-Host	String	Allowed Values: The input must be exactly one of the following — Nutanix-Cluster, Nutanix-Host",	Yes

Sample Response

HTTP Code: 200

[ { "NUMNETWORKADAPTERS": 1, "DISPLAYNAME": "opm-Nutanix44VM233", "VCPUCOUNT": 2, "VM_ID": 22, "statusStr": "Critical", "OS": "Windows 2012 R2", "DISKCAPACITY": "150", "IPADDRESS": "99.99.99.99", "MEMORYCAPACITY": "6", "statusNum": 1, "NAME": "99.99.99.99", "ISCONTROLLERVM": false, "SELECTIONSTATE": -5}]

Error Response

View common error responses

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

getNutanixStorageContainers

Retrieves detailed information about all storage containers configured within a specified Nutanix cluster. This API provides visibility into container-level storage resources used for hosting virtual machine data.

HTTP Method

GET

API URL

https://localhost:8060/api/json/device/getNutanixStorageContainers?apiKey=***************&deviceName=nutanix-cluster

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API Key to access your OpManager server.	String	-	Yes
deviceName	Name of the Nutanix device	String	-	Yes

Sample Response

HTTP Code: 200

{ "storageContainers": [ { "containerId": "container001", "containerName": "default-container", "totalCapacity": "10TB", "usedCapacity": "7TB", "status": "Online"} ]}

Error Response

View common error responses

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

getNutanixStoragePools

Retrieves detailed information about all storage pools available within a Nutanix cluster. Storage pools represent the combined physical storage resources that are used to create and manage storage containers and virtual machine workloads.

HTTP Method

GET

API URL

https://localhost:8060/api/json/device/getNutanixStoragePools?apiKey=***************&deviceName=nutanix-cluster

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API Key to access your OpManager server.	String	-	Yes
deviceName	Name of the Nutanix device	String	-	Yes

Sample Response

HTTP Code: 200

{ "storagePools": [ { "poolId": "pool001", "poolName": "SP1", "totalCapacity": "25TB", "usedCapacity": "18TB", "diskCount": 12} ]}

Error Response

View common error responses

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

getNutanixVGroups

Retrieves detailed information about all volume groups configured within a Nutanix cluster. Volume groups are used to present storage volumes directly to virtual machines or hosts.

HTTP Method

GET

API URL

https://localhost:8060/api/json/device/getNutanixVGroups?apiKey=***************&deviceName=nutanix-cluster

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API Key to access your OpManager server.	String	-	Yes
deviceName	Name of the Nutanix device	String	-	Yes

Sample Response

HTTP Code: 200

{ "volumeGroups": [ { "vGroupId": "vg001", "vGroupName": "production-vg", "diskCount": 5, "totalSize": "500GB", "usedSize": "350GB"} ]}

Error Response

View common error responses

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

getNutanixVMs

Retrieves detailed information about virtual machines within the Nutanix environment. Based on the specified entity type, this API can return virtual machine details either at the cluster level or the host level.

HTTP Method

GET

API URL

https://localhost:8060/api/json/device/getNutanixVMs?apiKey=***************&deviceName=nutanix-cluster

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API Key to access your OpManager server.			Yes
name	Name of the Nutanix device (cluster or host) from which virtual machines are to be retrieved with additional common info	String	-	Yes
type	Specifies the entity type. Accepted values: Nutanix-Cluster, Nutanix-Host	String	Allowed Values: The input must be exactly one of the following — Nutanix-Cluster, Nutanix-Host",	Yes

Sample Response

HTTP Code: 200

[ { "NUMNETWORKADAPTERS": 1, "DISPLAYNAME": "opm-Nutanix44VM233", "VCPUCOUNT": 2, "VM_ID": 22, "statusStr": "Critical", "OS": "Windows 2012 R2", "DISKCAPACITY": "150", "IPADDRESS": "99.99.99.99", "MEMORYCAPACITY": "6", "statusNum": 1, "NAME": "99.99.99.99", "ISCONTROLLERVM": false, "SELECTIONSTATE": -5}]

Error Response

View common error responses

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

Get URL Summary

Provides a summarized view of URL monitor performance by consolidating availability status, response time, and overall health metrics associated with the device.

HTTP Method

GET

API URL

https://localhost:8060/api/json/device/getURLSummary?apiKey=***************&deviceName=devicename

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API Key to access your OpManager server.			Yes
urlName	To list the Custom monitor, we have to use this parameter	String	Allowed Characters: Unicode letters, non-Basic Latin characters (supports international or multi-byte characters), digits, underscore (_), dot (.), hyphen (-), space, and colon (:)	Yes
snapType	Mandatory to fill this snapType as MonitoringURL	String(MonitoringURL)	Allowed Values: MonitoringURL	Yes

Sample Response

HTTP Code: 200

{ "viewData": "NODATA", "snapDetails":{ "snapList": [ { "indexCount": 0, "ondemandWidget": false, "refresh": false, "type": "URLSummary", "sizex": 10, "expand": false, "apiurl": "/client/api/json/admin/getURLSummary", "rowNum": 1, "parameter": "urlName", "isEnabled": true, "colNum": 1, "name": "opm.url.summary", "header": false, "id": 235, "snapid": 235, "expandtime": false, "parameters": [], "sizey": 12, "timeSelection": false, "desc": "dashboard.name.nwconfig"}, { "indexCount": 1, "ondemandWidget": false, "refresh": false, "type": "Grid", "sizex": 10, "expand": false, "apiurl": "/client/api/json/alarm/listAlarms", "rowNum": 8, "parameter": "urlName", "isEnabled": true, "colNum": 1, "name": "opm.url.alarms", "header": true, "id": 236, "snapid": 236, "snapshotData":{ "sortCol": "modTime", "sortOrder": "desc", "colModelList": [ { "classes": "cursorPointer", "name": "message", "index": "message"}, { "classes": "cursorPointer", "name": "who", "index": "who"}, { "formatter": "severityColorIcon", "classes": "cursorPointer", "name": "statusStr", "index": "statusStr"}, { "sorttype": "convertTimeToLongFormatter", "classes": "cursorPointer", "name": "modTime", "index": "modTime"}, { "hidden": true, "name": "statusNum", "index": "statusNum"}, { "hidden": true, "name": "entity", "index": "entity"}, { "hidden": true, "name": "alarmId", "index": "alarmId"}, { "hidden": true, "name": "modTimeLong", "index": "modTimeLong"} ], "colNamesList": [ "webclient.fault.event.text", "webclient.fault.alarm.operator", "webclient.fault.details.properties.severity", "webclient.fault.details.properties.modttime", "", "webclient.api.ui.event.entity", "webclient.api.ui.event.alarmid", "" ], "onselectfunction": "url_alarmsList"}, "expandtime": false, "parameters": [], "sizey": 14, "timeSelection": false, "desc": "webclient.devices.details.alarm"}, { "indexCount": 2, "ondemandWidget": false, "refresh": false, "type": "Graph", "sizex": 10, "expand": false, "apiurl": "/client/api/json/device/getGraphData", "rowNum": 22, "parameter": "name", "isEnabled": true, "colNum": 1, "name": "opm.url.response", "header": true, "id": 237, "snapid": 237, "expandtime": false, "parameters": [ { "param": "index", "paramData": [], "value": "urlresponseTime"}, { "param": "instance", "paramData": [], "value": "urlresponseTime"}, { "paramType": "urlresponseTime", "param": "withMMA", "paramData": [], "value": "true"}, { "param": "policyName", "paramData": [], "value": "urlresponseTime"}, { "paramType": "opmtime", "param": "period", "paramData": [], "value": "Today"} ], "sizey": 14, "timeSelection": true, "desc": "webclient.home.server.responsetime.column.time"} ], "snapshotID": "18", "snapshotDesc": "snapshot.desc.url", "snapshotName": "OPMURL", "tabs":{ "tabs": [ { "tabid": 55, "name": "webclient.snapshot.testlinks.summary", "order": 1}, { "tabid": 56, "name": "webclient.devices.details.alarm", "order": 2}, { "tabid": 57, "name": "webclient.home.server.responsetime.column.time", "order": 3} ], "tabWidgets":{ "55": [ { "ROW": 1, "ASSOCIATIONID": 235} ], "56": [ { "ROW": 8, "ASSOCIATIONID": 236} ], "57": [ { "ROW": 22, "ASSOCIATIONID": 237} ]}}, "timeSelectionNeeded": true, "yScale": 25, "maxColumns": 10}, "details":{ "alreadyExist": "false", "urlName": "ManageEngine", "displayName": "ManageEngine", "matchContent": "", "probeID": "0", "tester": "usertest", "isContainer": "false", "type": "URL", "moID": "119432", "timeout": "25", "responseCode": "", "suppressedMessage": "", "failureThreshold": "2", "errorContent": "", "managed": "true", "smartUrl": "https://www.manageengine.com", "siteID": "0", "state": "1", "statusPollEnabled": "false", "groupMembers": "", "DISPLAYNAME": "-", "lastPolled": "Mon,Oct 13 16:55:13 IST 2025", "method": "G", "isSuppressed": false, "stringstatus": "Clear", "responseTime": "103", "profile": "", "statusChangeTime": "1760294951262", "profileIDs": "", "AvailabilityImagePath":{ "Down": 0.487, "Dependent Unavailable": 0, "Not Monitored": 0, "On Hold": 0, "Parent Down": 0, "On Maintenance": 0, "Up": 99.513}, "userAgent": "", "queryString": "", "userName": "", "acceptCookie": "1", "url": "https://www.manageengine.com", "groupNames": "", "pollInterval": "5", "childrenKeys": "", "parentKey": "NULL", "nextPoll": "Mon,Oct 13 17:00:13 IST 2025", "name": "ManageEngine_URL", "isGroup": "false", "failureCount": "0", "statusUpdateTime": "1760294951262", "status": "5"}}

Error Response

View common error responses

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

listApplicationServices

The API returns a list of all available Application Service monitors (from AD, or MSSQL, or Exchange) that can be monitored within the product.

HTTP Method

GET

API URL

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

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API Key to access your OpManager server.			Yes
app	The type of application for which you need to get service details. The supported types are AD, MSSQL, and Exchange Version: This parameter is needed for the app type 'Exchange.' It is used to retrieve the respective version's Exchange services.	String	Allowed Values: The input must be exactly one of the following — AD,Exchange,MSSQL	Yes
version	This parameter is needed for the app type 'Exchange.' It is used to retrieve the respective version's Exchange services.	Integer	Allowed Values: The input must be exactly one of the following years — 2003, 2007, 2010, 2013, 2016, or 2019	No

Sample Response

HTTP Code: 200

[ { "serviceDesc": "The service synchronizes the time between domain controllers, which prevents time skews from occurring.", "serviceDisplayName": "Windows Time service", "autoAdd": true, "serviceid": 59, "serviceName": "W32Time"}, { "serviceDesc": "This service resolves and caches (Domain Name Server) DNS names.", "serviceDisplayName": "DNS Client Service", "autoAdd": true, "serviceid": 60, "serviceName": "Dnscache"}, { "serviceDesc": "This service maintains file synchronization of file directory contents among multiple servers.", "serviceDisplayName": "File Replication Service", "autoAdd": false, "serviceid": 61, "serviceName": "NtFrs"}, { "serviceDesc": "This service is used for mail-based replication between sites. Active Directory includes support for replication between sites by using SMTP over IP transport.", "serviceDisplayName": "Intersite Messaging Service", "autoAdd": true, "serviceid": 62, "serviceName": "IsmServ"}, { "serviceDesc": "This service enables users to log on to the network using the Kerberos version 5 authentication protocol.", "serviceDisplayName": "Kerberos Key Distribution Center Service", "autoAdd": true, "serviceid": 63, "serviceName": "kdc"}, { "serviceDesc": "This service signals other services that the Security Accounts Manager subsystem is ready to accept requests.", "serviceDisplayName": "Security Accounts Manager Service", "autoAdd": true, "serviceid": 64, "serviceName": "SamSs"}, { "serviceDesc": "This service enables the computer to connect to other computers on the network based on the SMB protocol.", "serviceDisplayName": "Server Service", "autoAdd": true, "serviceid": 65, "serviceName": "lanmanserver"}, { "serviceDesc": "This service provides network connections and communications.", "serviceDisplayName": "Workstation Service", "autoAdd": true, "serviceid": 66, "serviceName": "lanmanworkstation"}, { "serviceDesc": "This service provides the name services for RPC clients.", "serviceDisplayName": "Remote Procedure Call (RPC) Service", "autoAdd": true, "serviceid": 67, "serviceName": "RpcSs"}, { "serviceDesc": "This service supports pass-through authentication of account logon events for computers in a domain. ", "serviceDisplayName": "Net Logon Service", "autoAdd": true, "serviceid": 68, "serviceName": "Netlogon"}, { "serviceDesc": "This service enables synchronizing folders on multiple servers across local or WAN network", "serviceDisplayName": "DFS Replication", "autoAdd": true, "serviceid": 69, "serviceName": "DFSR"}]

Error Response

View common error responses

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

listPerformanceMonitors

This API returns a list of all performance monitors that can be monitored within the product, including properties such as displayName, protocol, identifier, graphName, associatedDeviceCount, isCustomGraph, and additional details.

HTTP Method

GET

API URL

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

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API Key to access your OpManager server.			Yes
isCustomMonitor	This parameter is used to filter and list only custom performance monitors. Set it to true to activate.	Boolean	Allowed Values: The input must exactly match either true or false	No
isCustFieldMonitor	This parameter is used to filter and list only custom filed based monitors. Set it to true to activate.	Boolean	Allowed Values: The input must exactly match either true or false	No

Sample Response

HTTP Code: 200

[ { "graphName": "CPUTemperature", "protocol": "SNMP", "custFieldGraph": "false", "Identifier": ".1.3.6.1.4.1.43.2.13.8.4.5.0", "customGraph": "false", "associatedDeviceCount": "2", "monitorName": "CPU Temperature", "displayName": "CPU Temperature", "vendor": "3Com", "description": "Monitors the CPU temperature", "graphId": "331"}, { "graphName": "CPUUtilization", "protocol": "SNMP", "custFieldGraph": "false", "Identifier": ".1.3.6.1.4.1.43.2.13.8.4.0", "customGraph": "false", "associatedDeviceCount": "2", "monitorName": "CPU Utilization", "displayName": "CPU Utilization", "vendor": "3Com", "description": "Monitors the CPU utilization", "graphId": "332"}, { "graphName": "hwCpuCostRatePer5Min", "protocol": "SNMP", "custFieldGraph": "false", "Identifier": ".1.3.6.1.4.1.43.45.1.6.1.1.1.4.65536", "customGraph": "false", "associatedDeviceCount": 0, "monitorName": "CPU Cost Rate (5 min)", "displayName": "CPU Cost Rate (5 min)", "vendor": "3Com", "description": "The overall CPU cost percentage in the last 5 minutes period.", "graphId": "3249"}, { "graphName": "hwMemFree", "protocol": "SNMP", "custFieldGraph": "false", "Identifier": ".1.3.6.1.4.1.43.45.1.6.1.2.1.1.3.65536", "customGraph": "false", "associatedDeviceCount": 0, "monitorName": "Free Memory", "displayName": "Free Memory", "vendor": "3Com", "description": "Indicates the free size of the memory", "graphId": "3250"}, { "graphName": "hwMemRawSliceUsed", "protocol": "SNMP", "custFieldGraph": "false", "Identifier": ".1.3.6.1.4.1.43.45.1.6.1.2.1.1.4.65536", "customGraph": "false", "associatedDeviceCount": 0, "monitorName": "Memory Raw slice used", "displayName": "Memory Raw slice used", "vendor": "3Com", "description": "Indicates the used size of the raw slice memory", "graphId": "3251"}, { "graphName": "hwBufCurrentUsed", "protocol": "SNMP", "custFieldGraph": "false", "Identifier": ".1.3.6.1.4.1.43.45.1.6.1.2.2.1.4.65536", "customGraph": "false", "associatedDeviceCount": 0, "monitorName": "Currently used buffer", "displayName": "Currently used buffer", "vendor": "3Com", "description": "The number of used buffer currently.", "graphId": "3252"}, { "graphName": "hwBufCurrentTotal", "protocol": "SNMP", "custFieldGraph": "false", "Identifier": ".1.3.6.1.4.1.43.45.1.6.1.2.2.1.3.65536", "customGraph": "false", "associatedDeviceCount": 0, "monitorName": "Total current buffer", "displayName": "Total current buffer", "vendor": "3Com", "description": "The total number of buffer currently.", "graphId": "3253"}, { "graphName": "hwBufSize", "protocol": "SNMP", "custFieldGraph": "false", "Identifier": ".1.3.6.1.4.1.43.45.1.6.1.2.2.1.2.65536", "customGraph": "false", "associatedDeviceCount": 0, "monitorName": "Buffer size", "displayName": "Buffer size", "vendor": "3Com", "description": "The size of buffer,unit is byte.", "graphId": "3254"}, { "graphName": "hwCpuCostRatePer1Min", "protocol": "SNMP", "custFieldGraph": "false", "Identifier": ".1.3.6.1.4.1.43.45.1.6.1.1.1.3.0", "customGraph": "false", "associatedDeviceCount": 0, "monitorName": "CPU Cost Rate (1 min)", "displayName": "CPU Cost Rate (1 min)", "vendor": "3Com", "description": "1 Minute CPU AVG", "graphId": "3255"}, { "graphName": "hwCpuCostRate5sec", "protocol": "SNMP", "custFieldGraph": "false", "Identifier": ".1.3.6.1.4.1.43.45.1.6.1.1.1.2.0", "customGraph": "false", "associatedDeviceCount": 0, "monitorName": "CPU Cost Rate (5 sec)", "displayName": "CPU Cost Rate (5 sec)", "vendor": "3Com", "description": "The overall CPU busy percentage in the last 5 second period.", "graphId": "3256"}, { "graphName": "A10CPUUtilization", "protocol": "SNMP", "custFieldGraph": "false", "Identifier": ".1.3.6.1.4.1.22610.2.4.1.3.3.0", "customGraph": "false", "associatedDeviceCount": 0, "monitorName": "CPU Utilization", "displayName": "CPU Utilization", "vendor": "A10 Networks", "description": "Monitors the average CPU usage in last 5 seconds.", "graphId": "526"}, { "graphName": "A10MemoryUtilization", "protocol": "SNMP", "custFieldGraph": "false", "Identifier": ".1.3.6.1.4.1.22610.2.4.1.2.2.0*100/.1.3.6.1.4.1.22610.2.4.1.2.1.0", "customGraph": "false", "associatedDeviceCount": 0, "monitorName": "Memory Utilization", "displayName": "Memory Utilization", "vendor": "A10 Networks", "description": "Monitors the memory utilization(%).", "graphId": "527"}, { "graphName": "A10GlobalConnections", "protocol": "SNMP", "custFieldGraph": "false", "Identifier": ".1.3.6.1.4.1.22610.2.4.3.19.1.10.0", "customGraph": "false", "associatedDeviceCount": 0, "monitorName": "Active Connections", "displayName": "Active Connections", "vendor": "A10 Networks", "description": "Monitors the count of current connections.", "graphId": "528"}, { "graphName": "A10SystemTemperature", "protocol": "SNMP", "custFieldGraph": "false", "Identifier": ".1.3.6.1.4.1.22610.2.4.1.5.1.0", "customGraph": "false", "associatedDeviceCount": 0, "monitorName": "System Temperature", "displayName": "System Temperature", "vendor": "A10 Networks", "description": "Monitors the physical system temperature in Celsius.", "graphId": "529"}, { "graphName": "A10FanStatus", "protocol": "SNMP", "custFieldGraph": "false", "Identifier": " .1.3.6.1.4.1.22610.2.4.1.5.9.1.3.0", "customGraph": "false", "associatedDeviceCount": 0, "monitorName": "Fan Status", "displayName": "Fan Status", "vendor": "A10 Networks", "description": "Monitors the fan status: 0: Failed, 4: OK-fixed/high, 5: OK-low/med, 6: OK-med/med, 7: OK-med/high, -2: not ready, 1: unknown.", "graphId": "530"}, { "graphName": "A10LowerPowerSupplyStatus", "protocol": "SNMP", "custFieldGraph": "false", "Identifier": ".1.3.6.1.4.1.22610.2.4.1.5.7.0", "customGraph": "false", "associatedDeviceCount": 0, "monitorName": "Lower Power Supply Status", "displayName": "Lower Power Supply Status", "vendor": "A10 Networks", "description": "Monitors the lower power supply status. Power supply status : off(0),on(1),unknown(-1).", "graphId": "531"}, { "graphName": "A10UpperPowerSupplyStatus", "protocol": "SNMP", "custFieldGraph": "false", "Identifier": ".1.3.6.1.4.1.22610.2.4.1.5.8.0", "customGraph": "false", "associatedDeviceCount": 0, "monitorName": "Upper Power Supply Status", "displayName": "Upper Power Supply Status", "vendor": "A10 Networks", "description": "Monitors the Upper power supply status. Power Supply status: off(0),on(1),unknown(-1).", "graphId": "532"}, { "graphName": "A10DiskFreeSpace", "protocol": "SNMP", "custFieldGraph": "false", "Identifier": ".1.3.6.1.4.1.22610.2.4.1.4.2.0", "customGraph": "false", "associatedDeviceCount": 0, "monitorName": "Free disk Space", "displayName": "Free disk Space", "vendor": "A10 Networks", "description": "Monitors the Free space of the disk in MB.", "graphId": "533"}, { "graphName": "A10DiskUtilization", "protocol": "SNMP", "custFieldGraph": "false", "Identifier": "(.1.3.6.1.4.1.22610.2.4.1.4.1.0-.1.3.6.1.4.1.22610.2.4.1.4.2.0)*100/.1.3.6.1.4.1.22610.2.4.1.4.1.0", "customGraph": "false", "associatedDeviceCount": 0, "monitorName": "Disk Utilization", "displayName": "Disk Utilization", "vendor": "A10 Networks", "description": "Monitors the usage of the disk in MB.", "graphId": "534"}]

Error Response

View common error responses

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

Map Entity

Starts monitoring a device or logical entity (like datastore) for real time health and performance updates.

HTTP Method

POST

API URL

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

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API Key to access your OpManager server.			Yes
entityID	EntityID will be available in the previous GET API (getVMWareVMs) when the particular Host or VM list widget is loaded. Eg: If a VMware VM is needed to be given start monitoring, then In vCenter snapshot page -> clicking on Virtual Machines tab will load Virtual Machines list widget with API 'getVMWareVMs', in this API response, VM_ID will be available which is the entityID.	long	-	Yes
virtualType	Virtual Type	String	Allowed Values: The input must be exactly one of the following — VMware-Datastore,VMware-Host,VMware-VM,HyperV-VM, Xen-VM,Nutanix-Host,Nutanix-VM,IPMI,Proxmox-Node,Proxmox-VM,Proxmox-Container	Yes
ipAddress	Ip Address/device name of the device to map	Boolean		No
credentialIDs	IDs of the credential profiles with which the devices needs to be monitored	JSONArray	Regex :: Array of the Long ["30604"]	No

Sample Response

HTTP Code: 200

{ "result": "true", "status": "Started monitoring the VM New Virtual Machine with ipAddress test-2k16.corporation.com"}

Error Response

View common error responses

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

suppressVSANDiskAlarm

To enable or disable alarm notifications for specific VSAN disk issues. This allows administrators to temporarily suppress alerts during maintenance activities or troubleshoot without generating unnecessary alarm noise.

HTTP Method

POST

API URL

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

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API Key to access your OpManager server.			Yes
diskID	diskID will be available in previous get API 'getVMwareVSANDiskInfo' when this vSAN disk list widget is loaded. API response - 'DISKID'	long	-	Yes
enable	Flag to enable or disable the alarm notification (true to suppress , false to enable)	Boolean	-	Yes

Sample Response

HTTP Code: 200

{ "result":{ "message": "Alert suppression has been enabled successfully for vSAN Disk VsanDisk0"}}

Error Response

View common error responses

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

Unmap Entity

Stops monitoring of the device, but still the entry will be present under the inventory without any real time tracking of device health and performance

HTTP Method

POST

API URL

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

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API Key to access your OpManager server.			Yes
entityID	EntityID will be available in the previous GET API (getVMWareVMs) when the particular Host or VM list widget is loaded. Eg: If a VMware VM is needed to be given start monitoring, then In vCenter snapshot page -> clicking on Virtual Machines tab will load Virtual Machines list widget with API 'getVMWareVMs', in this API response, VM_ID will be available which is the entityID.	long	-	Yes
virtualType	Virtual Type	String	Allowed Values: The input must be exactly one of the following — VMware-Host, VMware-VM, HyperV-VM, Xen-VM, Nutanix-VM, Nutanix-Host, IPMI, Proxmox-VM, or Proxmox-Container	Yes

Sample Response

HTTP Code: 200

{ "result": "true", "status": "Stopped monitoring server as Virtual Server"}

Error Response

View common error responses

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