Devices

listDevices

Lists all devices monitored by OpManager.

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
page	Used along with the rows parameter to fetch data in batches.	Integer	Example: page=1&rows=100	No
rows	Number of rows to fetch in the current batch.	Integer	Example: rows=100 or page=1&rows=100	No

Sample Response

HTTP Code: 200

{
  "total": 0,
  "page": 1,
  "rows": [
    {
      "isSNMP": true,
      "ipaddress": "xxx.xxx.xx.x",
      "isSuppressed": false,
      "statusStr": "Clear",
      "prettyTime": "5 hours ago",
      "displayName": "xxx.xxx.xx.x",
      "isNew": false,
      "type": "Windows 10",
      "vendorName": "Microsoft",
      "deviceName": "xxx.xxx.xx.x",
      "moid": 341,
      "statusNum": "5",
      "suppressedMessage": "",
      "addedTime": "7 Oct 2025 11: 08: 30 AM IST",
      "interfaceCount": 0,
      "id": "341",
      "category": "Desktop"
    },
    {
      "isSNMP": true,
      "ipaddress": "xxx.xxx.xx.x",
      "isSuppressed": false,
      "statusStr": "Clear",
      "prettyTime": "5 hours ago",
      "displayName": "xxx.xxx.xx.x",
      "isNew": false,
      "type": "Windows 2019",
      "vendorName": "Microsoft",
      "deviceName": "xxx.xxx.xx.x",
      "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

listSubnets

Lists all the Subnets added in OpManager

HTTP Method

GET

API URL

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

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API key to access your OpManager server.	String	-	Yes

Sample Response

HTTP Code: 200

{
    "1.1.1.0": {
        "data": [
            {
                "Status": "7",
                "Label": "Unknown",
                "Count": "1"
            },
            {
                "Status": "7",
                "Label": "Unknown",
                "Count": "1"
            }
        ],
        "displayName": "1.1.1.0",
        "subnetDisplayName": ""
    },
    "10.10.10.0": {
        "data": [
            {
                "Status": "5",
                "Label": "Clear",
                "Count": "1"
            },
            {
                "Status": "5",
                "Label": "Clear",
                "Count": "1"
            }
        ],
        "displayName": "10.10.10.0",
        "subnetDisplayName": ""
    },
    "10.5.5.0": {
        "data": [
            {
                "Status": "1",
                "Label": "Critical",
                "Count": "1"
            },
            {
                "Status": "1",
                "Label": "Critical",
                "Count": "1"
            },
            {
                "Status": "2",
                "Label": "Trouble",
                "Count": "1"
            },
            {
                "Status": "2",
                "Label": "Trouble",
                "Count": "1"
            },
            {
                "Status": "2",
                "Label": "Trouble",
                "Count": "1"
            },
            {
                "Status": "2",
                "Label": "Trouble",
                "Count": "1"
            },
            {
                "Status": "5",
                "Label": "Clear",
                "Count": "1"
            },
            {
                "Status": "5",
                "Label": "Clear",
                "Count": "1"
            },
            {
                "Status": "5",
                "Label": "Clear",
                "Count": "1"
            },
            {
                "Status": "5",
                "Label": "Clear",
                "Count": "1"
            },
            {
                "Status": "5",
                "Label": "Clear",
                "Count": "1"
            },
            {
                "Status": "5",
                "Label": "Clear",
                "Count": "1"
            },
            {
                "Status": "7",
                "Label": "Unknown",
                "Count": "1"
            }
        ],
        "displayName": "10.5.5.0",
        "subnetDisplayName": ""
    },
    "30.30.30.0": {
        "data": [
            {
                "Status": "5",
                "Label": "Clear",
                "Count": "1"
            }
        ],
        "displayName": "30.30.30.0",
        "subnetDisplayName": ""
    }
}

Error Response

View common error responses

Rate limit: 300 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=opmserver.mydomain.com

Parameters

Note: While deviceName, ipAddress, and dnsName are each marked as not mandatory, at least one of the three must be provided in the request.

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API key to access your OpManager server.	String	-	Yes
deviceName	Internal name of the device used to uniquely identify it. This value can be retrieved from the deviceName field in the listDevices API response.	String	-	No
ipAddress	IP address of the device. This value can be retrieved from the ipaddress field in the listDevices API response.	String	-	No
dnsName	DNS name of the device. This value can be retrieved from the dnsName field in the getDeviceSummary API response.	String	-	No

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

setDeviceInfo

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

HTTP Method

POST

API URL

https://localhost:8060/api/json/device/setDeviceInfo?apiKey=***************&deviceName=opmserver.mydomain.com&values=[{"metricName":"SoftwareVersion","metricValue":"10.0.26101"},{"metricName":"Model","metricValue":"VMware8,1"}]

Parameters

Note: While deviceName, ipAddress, and dnsName are each marked as not mandatory, at least one of the three must be provided in the request.

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API key to access your OpManager server.	String	-	Yes
deviceName	Internal name of the device used to uniquely identify it. This value can be retrieved from the deviceName field in the listDevices API response.	String	-	No
ipAddress	IP address of the device. This value can be retrieved from the ipaddress field in the listDevices API response.	String	-	No
dnsName	DNS name of the device. This value can be retrieved from the dnsName field in the getDeviceSummary API response.	String	-	No
values	Device attributes to be updated. Include only the attributes that need to be updated. Supported attributes: HDD, RAM, Model, Manufacturer, OperatingSystem, SoftwareVersion.	JSONArray	Example: `[{"metricName":"SoftwareVersion","metricValue":"10.0.26101"},{"metricName":"Model","metricValue":"VMware8,1"}]`	Yes

Sample Response

HTTP Code: 200

{
    "result": {
        "message": "Values updated successfully"
    }
}

Error Response

View common error responses

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

getDeviceNotes

Retrieves custom fields (notes) associated with a specific device. Returns device-specific custom field values along with field metadata including data type and field length.

HTTP Method

GET

API URL

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

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API key to access your OpManager server.	String	-	Yes
name	Name of the device, retrieved from the deviceName field in the listDevices API response.	String	-	Yes

Sample Response

HTTP Code: 200

[
    {
      "FIELDVALUE": "Data Center A",
      "DATATYPE": "Text",
      "ISMONAVAIL": false,
      "ISEDITABLE": true,
      "DESCRIPTION": "Device location information",
      "FIELDNAME": "Location",
      "ALIASNAME": "UDF1",
      "FIELDLENGTH": 250
    },
    {
      "FIELDVALUE": "AT-001234-XP",
      "DATATYPE": "Text",
      "ISMONAVAIL": false,
      "ISEDITABLE": true,
      "DESCRIPTION": "Serial number of the device",
      "FIELDNAME": "Serial Number",
      "ALIASNAME": "UDF2",
      "FIELDLENGTH": 50
    }
  ]

Error Response

View common error responses

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

getInfrastructureDetailsView

Provides device details such as device name, status, the associated performance monitor values etc, based on the given category.

HTTP Method

GET

API URL

https://localhost:8060/api/json/discovery/getInfrastructureDetailsView?apiKey=**************&categoryName=Server

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API key to access your OpManager server.	String	-	Yes
categoryName	The device category can be retrieved from the getCategoryList API response.	String	-	Yes

Sample Response

HTTP Code: 200

{
    "InfrastructureDetailsView": {
        "Details": [
            {
                "severity": "5",
                "intfCount": "95",
                "displayName": "xxx.xxx.xx.x",
                "name": "xxx.xxx.xx.x",
                "IpAddress": "xxx.xxx.xx.x",
                "type": "Windows 2019",
                "status": "Clear",
                "monitors": {
                    "DiskUtilization": 95,
                    "CPUUtilization": 22,
                    "MemoryUtilization": 84
                }
            },
            {
                "severity": "5",
                "intfCount": "0",
                "displayName": "xxx.xxx.xx.x",
                "name": "xxx.xxx.xx.x",
                "IpAddress": "xxx.xxx.xx.x",
                "type": "Dell PowerEdge iDRAC",
                "status": "Clear",
                "monitors": {
                    "DiskUtilization": 0,
                    "CPUUtilization": 0,
                    "MemoryUtilization": 0
                }
            },
           
        "TotalRecords": "2"
    }

Error Response

View common error responses

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

getDeviceSummary

Retrieves device summary and snapshot information including current status, monitoring configuration, availability and device properties such as IP address, MAC address, DNS name, and related metadata.

HTTP Method

GET

API URL

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

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API key to access your OpManager server.	String	-	Yes
name	Internal name of the device, retrieved from the deviceName field in the listDevices API response.	String	-	Yes

Sample Response

HTTP Code: 200

{
    "hardDiskSize": 149,
    "ramSize": 16384,
    "type": "Windows 2016",
    "ISHWMONITORED": false,
    "deviceName": "xxx.xxx.xx.x",
    "moID": "277",
    "sysDescr": "",
    "sysName": "",
    "state": "1",
    "statusPollEnabled": true,
    "hardDiskSizeWithUnit": "149 GB",
    "dependency": "None",
    "displayCategory": "Server",
    "ipAddress": "xxx.xxx.xx.x",
    "Encoding": "ISO-8859-1",
    "vendorName": "Microsoft",
    "statusNum": "3",
    "customLinks": [
        {
            "URL": "https://manageengine.com",
            "NAME": "ManageEngineSite"
        }
],
    "parentCategory": "Server",
    "status": "Attention",
    "isSNMP": true,
    "deviceProtocol": "WMI",
    "statusStr": "Attention",
    "pollUsingIPorDNS": "PollUsingIP",
    "displayName": "OPM-Server38",
    "dnsName": "xxx.xxx.xx.x",
    "availability": [
        "UP,1782230446595,1782310606595,Up"
    ],
    "snmpport": "161",
    "pollPeriod": "60",
    "managed": "true",
    "deviceTypeID": 1156,
    "pollUsing": "ICMP",
    "responseTime": "001ms",
    "packetLoss": "0",
    "isNetwork": false,
    "isDevicePingable": "true",
    "category": "Server",
    "ramSizeWithUnit": "16 GB"
                    }

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

{
    "credentialAssociated": "false",
    "nfadetails": {
        "NFAStatus": "Not Added"
    },
    "statusStr": "Clear",
    "responseTime": "001ms",
    "showCredentialNotAssociatedMsg": "true",
    "format": "d MMM yyyy hh:mm:ss a z",
    "dnsName": "xxx.xxx.xxx.xx",
    "timeZone": "Asia/Calcutta",
    "availability": [
        "UP,1782844226426,1782912206426,Up"
    ],
    "todayTimeAvail": {
        "todayStartTime": "1782844226466",
        "endTimeVal": "1782912206466"
    },
    "type": "Windows 2019",
    "vendorName": "Microsoft",
    "statusNum": "5",
    "isStorage": false,
    "ncmdetails": {
        "SUMMARY_NOT_AVAILABLE": true
    },
    "packetLoss": "0",
    "configBackup": {
        "RunningConfig": {},
        "StartupConfig": {}
    },
    "oputilsDetails": {
        "summaryAvailable": false
    },
    "opmdetails": {
        "Type": "Windows 2019",
        "dependentDisplayName": "None",
        "Category": "Server",
        "displayCategory": "Servers",
        "PollInterval": "5",
        "IPAddress": "xxx.xxx.xxx.xx",
        "DNSName": "xxx.xxx.xxx.xx",
        "SysDescription": "",
        "Monitoring": "ICMP",
        "UpLinkDependency": "None"
    },
    "state": "1",
    "availdata": {
        "Down": 0,
        "Dependent Unavailable": 0,
        "Not Monitored": 0,
        "On Hold": 0,
        "Parent Down": 0,
        "On Maintenance": 0,
        "Up": 100
    }
}

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 virtual devices along with inventory details monitored by OpManager based on the specified virtual device type.

HTTP Method

GET

API URL

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

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API key to access your OpManager server.	String	-	Yes
virtualDeviceType	Type of virtual device to be listed.	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. Here, VM refers to VMware Virtual Machine, VDATASTORE refers to VMware Datastore, and VHOST refers to VMware Host.	Yes

Sample Response

HTTP Code: 200

[
  {
    "DISPLAYNAME": "opm-server89",
    "VM_ID": 1234,
    "statusStr": "Critical",
    "VM_POWERSTATE": "On",
    "MAX_CPU_MHZ": 14366,
    "IPADDRESS": "10.1.1.9",
    "OS_NAME": "Microsoft Windows Server 2019 (64-bit)",
    "deviceName": "opm-server89",
    "statusNum": 1,
    "MEMORY_MB": 16384,
    "STATUS": "\u003Cimg src='/images/devices/status1.gif'\u003E Critical",
    "HOSTNAME": "opm-server89",
    "MOID": 1004,
    "id": 1004,
    "state": 1
  },
  {
    "DISPLAYNAME": "opm-server90",
    "VM_ID": 5678,
    "statusStr": "Critical",
    "VM_POWERSTATE": "On",
    "MAX_CPU_MHZ": 4788,
    "IPADDRESS": "10.1.1.10",
    "OS_NAME": "Ubuntu Linux (64-bit)",
    "deviceName": "opm-server90",
    "statusNum": 1,
    "MEMORY_MB": 8192,
    "STATUS": "\u003Cimg src='/images/devices/status1.gif'\u003E Critical",
    "HOSTNAME": "opm-server90",
    "MOID": 1005,
    "id": 1005,
    "state": 1
  }
]

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 along with inventory details monitored by OpManager for the specified type scope at either the vCenter level or the VxRail level.

HTTP Method

GET

API URL

https://localhost:8060/api/json/device/getVMWareHosts?apiKey=***************&name=virtual-server&type=VCENTER

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API key to access your OpManager server.	String	-	Yes
name	Internal name of the device used to uniquely identify it. The 'name' value can be obtained from the 'deviceName' key in the JSON response of the listVirtualDevices API response. Pass the 'virtualDeviceType' parameter as 'VCENTER' or 'VxRail' in the listVirtualDevices API to retrieve the corresponding virtual devices.	String	-	Yes
type	Virtual entity type used to retrieve VMware host details.	String	Allowed values: 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	Internal ID of the VMware vCenter used to uniquely identify it. The 'moID' value can be obtained from the 'MOID' key in the JSON response of the listVirtualDevices API response. Pass the 'virtualDeviceType' parameter as 'VCENTER' in the listVirtualDevices API to retrieve the corresponding virtual devices.	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

Fetches all clusters associated with a specific vCenter and provides visibility into the vCenter inventory structure at cluster level.

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.	String	-	Yes
moID	Internal ID of the VMware vCenter used to uniquely identify it. The 'moID' value can be obtained from the 'MOID' key in the JSON response of the listVirtualDevices API response. Pass the 'virtualDeviceType' parameter as 'VCENTER' in the listVirtualDevices API to retrieve the corresponding virtual devices.	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 VMs monitored by OpManager for the specified entity type details at multiple levels, including vCenter, Host, Datastore and VxRail, to provide flexible storage visibility throughout the VMware environment.

HTTP Method

GET

API URL

https://localhost:8060/api/json/device/getVMWareVMs?apiKey=***************&name=vcenter.mydomain.com

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API key to access your OpManager server.	String	-	Yes
name	Internal name of the monitored VMware entity used to uniquely identify it. The 'name' value can be obtained from the 'deviceName' key in the JSON response of the listVirtualDevices API response. Pass the 'virtualDeviceType' parameter as 'VCENTER' or 'VHOST', 'VxRail', 'VDATASTORE' in the listVirtualDevices API to retrieve the corresponding virtual devices.	String	-	Yes
type	Specifies the VMware entity level for which VM details should be retrieved. If not specified, VM details are retrieved based on the provided name.	String	Allowed Values: The input must be exactly one of the following - VCENTER,HOST,DATASTORE,VXRAIL. Here, HOST refers to VMware Host, and DATASTORE refers to VMware Datastore.	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=***************&name=vcenter.mydomain.com

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API key to access your OpManager server.	String	-	Yes
name	Internal name of the monitored VMware entity used to uniquely identify it. The 'name' value can be obtained from the 'deviceName' key in the JSON response of the listVirtualDevices API response. Pass the 'virtualDeviceType' parameter as 'VCENTER' or 'VHOST', 'VxRail', 'VM' in the listVirtualDevices API to retrieve the corresponding virtual devices.	String	-	Yes
type	Specifies the VMware entity level for which datastore associated details should be retrieved. If not specified, datastore details are retrieved based on the provided name.	String	Allowed Values: The input must be exactly one of the following - VCENTER,HOST,VM,VXRAIL Here, HOST refers to VMware Host, and VM refers to VMware Virtual Machine.	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 associated to the specific VM in a Nutanix cluster

HTTP Method

GET

API URL

https://localhost:8060/api/json/device/getNutanixVDisks?apiKey=***************&name=nutanix-vm.mydomain.com

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API key to access your OpManager server.	String	-	Yes
name	Internal name of the managed Nutanix VM used to uniquely identify it. This value can be retrieved from the name field in the getNutanixVMs 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

Retrieves detailed information about Nutanix infrastructure components based on the specified entity types such as virtual machines, hosts, or clusters.

HTTP Method

GET

API URL

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

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API key to access your OpManager server.	String	-	Yes
deviceName	Internal name of the managed entity used to uniquely identify it. This value can be retrieved from the deviceName field in the listVirtualDevices API response.	String	-	Yes
entityType	Virtual entity type used to retrieve Nutanix device details.	String	Allowed values: 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 monitor 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=opm-server.mydomain.com&vxrailDeviceName=vxrailtest.mydomain.com&vxrailCredentialName=Vxrailcred

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API key to access your OpManager server.	String	-	Yes
deviceName	Internal name of the vCenter device to which the VxRail device should be added. This value can be retrieved from the deviceName field in the listVirtualDevices API response. Pass virtualDeviceType as VCENTER in the listVirtualDevices API to retrieve the vCenter devices.	String	-	Yes
vxrailDeviceName	IP address or DNS name of the VxRail device to be added to the vCenter.	String	-	Yes
vxrailCredentialName	Credential profile to be used for discovering the VxRail device. Multiple credentials can be entered as comma-separated values.	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.	String	-	Yes
name	Internal name of the device used to uniquely identify it. The 'name' value can be obtained from the 'deviceName' key in the JSON response of the listDevices API.	String	-	Yes
policyName	Internal name of the monitor used to uniquely identify it. The 'policyName' value can be obtained from the 'policyName' key in the JSON response of the getPerformanceMonitorDetails API.	String	-	Yes
graphName	Additional parameter of the performance monitor used to uniquely identify it. The 'graphName' value can be obtained from the 'name' key in the JSON response of the getDeviceAssociatedMonitors API.	String	If the monitor is an instance-based monitor (e.g., a partition-based monitor), pass the instance name using this parameter. This parameter works along with policyName. Example: To perform this operation on the D: partition monitor, pass this parameter as D:	No
pollId	Internal id of the monitor used to uniquely identify it. The 'pollId' value can be obtained from the 'Id' key in the JSON response of the getPerformanceMonitorDetails API.	Long	-	Yes
checkNumeric	Indicates whether the monitor returns a numeric value or a string value. The 'checkNumeric' value can be obtained from the 'checkNumeric' key in the JSON response of the getPerformanceMonitorDetails API.	Boolean	-	Yes
displayName	DisplayName of the performance monitor. The 'displayName' value can be obtained from the 'DISPLAYNAME' key in the JSON response of the getPerformanceMonitorDetails API.	String	-	Yes
thresholdName	Internal name of the threshold used to uniquely identify it.	String	-	Yes
type	Internal type of the monitor used to uniquely identify it. The 'type' value can be obtained from the 'graphType' key in the JSON response of the getPerformanceMonitorDetails API.	String	-	Yes
timeAvg	timeAvg of the monitor.	String	The parameter must be provided with an empty value.	Yes
vendor	Vendor of the monitor.	String	The parameter must be provided with an empty value.	Yes
sendClear	SendClear of the monitor.	Boolean	The parameter must be provided with 'true' as its value.	-
oid	Internal OID of the monitor used for data collection. The 'oid' value can be obtained from the 'oid' key in the JSON response of the getPerformanceMonitorDetails API.	String	-	Yes
interval	Specifies the interval of the monitor to be updated, in minutes. The 'interval' value can be obtained from the 'interval' key in the JSON response of the getPerformanceMonitorDetails API.	Integer	-	Yes
yaxisText	Unit of a performance monitor. The 'yaxisText' value can be obtained from the 'YAXISTEXT' key in the JSON response of the getPerformanceMonitorDetails API.	String	-	Yes
failureThreshold	Specifies the number of consecutive times the threshold must be violated before an alert is generated. The 'failureThreshold' value can be obtained from the 'FAILURETHRESHOLD' key in the JSON response of the getPerformanceMonitorDetails API.	Integer	-	Yes
oidType	Internal type of the oid uniquely used to identify it.	String	The parameter must be provided with an empty value.	-
firstTime	Used to identify whether the monitor is being modified for the first time.	Boolean	The parameter must be provided with 'false' as its value.	-
thresholdEnabled	The 'thresholdEnabled' value can be obtained from the 'THRESHOLDENABLED' key in the JSON response of the getPerformanceMonitorDetails API.	Boolean	-	No
perfDataStoreType	Data should be stored or not	int	-	No
instanceName	When the monitor is an MSSQL Application Monitor, pass this parameter with the MSSQL instance name. MSSQL Instance name can be fetched from the end device or can be viewed from MSSQL Tab in device snapshot page of MSSQL device in OpManager.	String	-	No
isGraphNeeded	Specifies whether data storage is enabled for the monitor. The 'isGraphNeeded' value can be obtained from the 'sSave' key in the JSON response of the getPerformanceMonitorDetails API.	Boolean	-	Yes
isAdaptiveThresholdsEnabled	Specifies whether the adaptive threshold is enabled.	Boolean	-	No
deviationType	Specifies the deviation type of the adaptive threshold: 1 for percentage and 2 for value.	Integer	Allowed values: 1 (deviation in percentage) \| 2 (deviation in value)	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	Exchange Store Location	String	Accepts filenames ending with .edb or .stm that do not contain sequences like ../, ..\, \\, //, <, >, and do not end with ..	No
minInterval	Minimum 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	Allowed Values: 1 \| 2 \| 3 \| 4 \| 6	No
downConsecutiveTime	Consecutive time of the service monitor	int	Allowed Values: 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 adaptive threshold	double	-	No
upperlimitThresholdValue	Upper limit of the Threshold value of the adaptive threshold	double	-	No
rearmValue	Rearm of the Threshold value of the monitor	double	-	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

Retrieve the list of monitors configured for one or more devices in OpManager. By providing the device name(s), the API returns the monitors associated with those 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.	String	-	Yes
deviceList	Internal name of the device used to uniquely identify it. Multiple device names can be specified as a comma-separated list. This value can be retrieved from the deviceName field in the listDevices API response.	String	-	Yes

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=opm-server.mydomain.com

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API key to access your OpManager server.	String	-	Yes
name	Internal name of the device used to uniquely identify it. This value can be retrieved from the deviceName field in the listDevices API response.	String	-	Yes

Sample Response

HTTP Code: 200

{
  "performanceMonitors":{
  "performanceMonitors": {
    "total": 4,
    "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": "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": "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"
      }
    ]
  },
  "serverMonitors": {
    "total": 1,
    "down": 1,
    "monitors": [
      {
        "portNo": "25",
        "failureThreshold": 1,
        "statusText": "webclient.devices.intftypes.down",
        "name": "SMTP",
        "status": "images/servicestatus7.gif"
      }
    ]
  },
  "ntServiceMonitors": {
    "total": 2,
    "down": 2,
    "monitors": [
      {
        "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": 1,
    "down": 1,
    "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"
      }
    ]
  },
  "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=opm-server.mydomain.com

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API key to access your OpManager server.	String	-	Yes
name	Internal name of the device used to uniquely identify it. This value can be retrieved from the deviceName field in the listDevices API response.	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=opm-server.mydomain.com

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API key to access your OpManager server.	String	-	Yes
name	Internal name of the device used to uniquely identify it. This value can be retrieved from the deviceName field in the listDevices API response.	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

getDeviceAssociatedWindowsServiceMonitors

Fetches the list of Windows service monitors associated to a device

HTTP Method

GET

API URL

https://localhost:8060/api/json/device/getDeviceAssociatedWindowsServiceMonitors?apiKey=***************&name=opm-server.mydomain.com

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API key to access your OpManager server.	String	-	Yes
name	Internal name of the device used to uniquely identify it. The 'name' value can be obtained from the 'deviceName' key in the JSON response of the listDevices API.	String	-	Yes

Sample Response

HTTP Code: 200

[
  {
    "displayName": "Print Spooler",
    "serviceName": "Spooler",
    "serviceID": "1",
    "status": "Clear"
  },
  {
    "displayName": "RPC",
    "serviceName": "RpcSs",
    "serviceID": "14",
    "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=***************&name=xxx.xxx.xx.x&policyName=WMI-CPUUtilization&index=WMI-CPUUtilization

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API key to access your OpManager server.	String	-	Yes
name	Internal name of the device used to uniquely identify it. The 'name' value can be obtained from the 'deviceName' key in the JSON response of the listDevices API.	String	-	Yes
parentObj	Specifies the parent object associated with the monitor. Applicable only for monitor types that require a parent entity reference, such as Meraki Uplink.	String	-	No
policyName	Internal name of the monitor used to uniquely identify it. The 'policyName' value can be obtained from the 'policyName' key in the JSON response of the getDeviceAssociatedMonitors API.	String	-	Yes
index	Additional parameter of the performance monitor used to uniquely identify it. The 'graphName' value can be obtained from the 'name' key in the JSON response of the getDeviceAssociatedMonitors API.	String	If the monitor is an instance-based monitor (e.g., a partition-based monitor), pass the instance name using this parameter. This parameter works along with policyName. Example: To perform this operation on the D: partition monitor, pass this parameter as D:	Yes
period	Specifies the time range for which monitor data should be retrieved.	String	Supports predefined time periods are onehour, twohours, fourhours, sixhours, twelvehours, twfourhours, Today, Last_7_Days, Last_30_Days, Last_60_Days, Last_90_Days, Yesterday, thisweek, lastweek, thismonth, Last_Month, Last_Quarter, This_Quarter, Last_3_Months, Last_6_Months, custom.	No
instance	Internal name used to identify availability instance of a monitor.	String	Allowed Values: The input must contain one of the following - urlResponseTime, responseTime, packetLoss	No
isHardwareGraph	Boolean flag indicating whether the requested graph is based on hardware sensor metrics.	Boolean	Allowed Values: The input must exactly match either true or false	No
parameterName	Name of the hardware sensor parameter to retrieve data for. This parameter is applicable only when isHardwareGraph is true.	String	-	No
withMMA	Set this parameter to true to include historical data along with min, max, and average values in the response.	Boolean	Allowed Values: The input must exactly match either true or false	No
startDate	When the graph needs to be retrieved for a custom period, this parameter is required. It specifies the start of the custom time range. Format: dd/MM/yyyy HH:mm.	String	Example: 17/08/2026 00:02	No
endDate	When the graph needs to be retrieved for a custom period, this parameter is required. It specifies the end of the custom time range. Format: dd/MM/yyyy HH:mm.	String	Example: 18/08/2026 13:55	No
instanceName	When the monitor is an MSSQL Application Monitor, pass this parameter with the MSSQL instance name. MSSQL Instance name can be fetched from the end device or can be viewed from MSSQL Tab in device snapshot page of MSSQL device in OpManager.	String	-	No
graphFilterType	Specifies the aggregation type used for fetching historical graph data.	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=opm-server.mydomain.com

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API key to access your OpManager server.	String	-	Yes
name	Internal name of the device used to uniquely identify it. This value can be retrieved from the deviceName field in the listDevices API response.	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=**************&name=opm-server.mydomain.com&type=Nutanix-Cluster

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API key to access your OpManager server.	String	-	Yes
name	Internal name of the managed Nutanix entity used to uniquely identify it. This value can be retrieved from the deviceName field in the listVirtualDevices API response. Pass virtualDeviceType as Nutanix-Cluster or Nutanix-Host in the listVirtualDevices API to retrieve the corresponding virtual devices.	String	-	Yes
type	Specifies the Nutanix entity type for which disk details should be retrieved.	String	Allowed values: 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=***************&name=nutanix-cluster

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API key to access your OpManager server.	String	-	Yes
name	Internal name of the device used to uniquely identify it. This value can be retrieved from the deviceName field in the listDevices API response.	String	-	Yes

Sample Response

HTTP Code: 200

[
  {
    "DISPLAYNAME": "NutanixHost1",
    "statusStr": "Critical",
    "DISKCAPACITY": "19560.36",
    "IPADDRESS": "10.255.1.255",
    "HYPERVISORDETAIL": "Nutanix 20170830.265",
    "CPUMODEL": "Intel(R) Xeon(R) Gold 6138 CPU @ 2.00GHz",
    "MEMORYCAPACITY": "503.49",
    "statusNum": 1,
    "NAME": "nutanixHost1.mydomain.com",
    "BOOTTIME": "2019-05-27 20:48:24.153",
    "SELECTIONSTATE": 1,
    "NUMCPUCORES": 40,
    "HOST_ID": 21,
    "state": 2,
    "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=***************&name=nutanix.mydomain.com&type=Nutanix-Cluster

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API key to access your OpManager server.	String	-	Yes
name	Internal name of the managed Nutanix entity used to uniquely identify it. This value can be retrieved from the deviceName field in the listVirtualDevices API response. Pass virtualDeviceType as Nutanix-Cluster or Nutanix-Host in the listVirtualDevices API to retrieve the corresponding virtual devices.	String	-	Yes
type	Specifies the Nutanix entity type for which disk details should be retrieved.	String	Allowed values: 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=***************&name=nutanix-cluster

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API key to access your OpManager server.	String	-	Yes
name	Internal name of the managed Nutanix Cluster used to uniquely identify it. The 'name' value can be obtained from the 'deviceName' key in the JSON response of the listVirtualDevices API response. Pass the 'virtualDeviceType' parameter as 'Nutanix-Cluster' in the listVirtualDevices API to retrieve the corresponding virtual devices.	String	-	Yes

Sample Response

HTTP Code: 200

[
    {
        "CAPACITY": "77150.47",
        "CACHEDUPLICATION": "POST_PROCESS",
        "RF": 2,
        "ERASUREENCODING": "on",
        "USAGE": "334.77",
        "COMPRESSION": true,
        "SC_ID": 5,
        "NAME": "default-container"
    },
    {
        "CAPACITY": "76889.46",
        "CACHEDUPLICATION": "OFF",
        "RF": 2,
        "ERASUREENCODING": "off",
        "USAGE": "73.75",
        "COMPRESSION": true,
        "SC_ID": 6,
        "NAME": "NutanixMgmtShare"
    },
    {
        "CAPACITY": "79379.09",
        "CACHEDUPLICATION": "POST_PROCESS",
        "RF": 2,
        "ERASUREENCODING": "on",
        "USAGE": "2563.39",
        "COMPRESSION": true,
        "SC_ID": 7,
        "NAME": "opm-NutanixSC"
    },
    {
        "CAPACITY": "76919.13",
        "CACHEDUPLICATION": "OFF",
        "RF": 2,
        "ERASUREENCODING": "off",
        "USAGE": "103.43",
        "COMPRESSION": false,
        "SC_ID": 8,
        "NAME": "SelfServiceSC"
    },
    {
        "CAPACITY": "84430.68",
        "CACHEDUPLICATION": "OFF",
        "RF": 2,
        "ERASUREENCODING": "off",
        "USAGE": "7614.97",
        "COMPRESSION": true,
        "SC_ID": 9,
        "NAME": "Database"
    },
    {
        "CAPACITY": "87090.02",
        "CACHEDUPLICATION": "POST_PROCESS",
        "RF": 2,
        "ERASUREENCODING": "on",
        "USAGE": "10274.31",
        "COMPRESSION": true,
        "SC_ID": 10,
        "NAME": "General"
    }
]

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=***************&name=nutanix-cluster

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API key to access your OpManager server.	String	-	Yes
name	Internal name of the managed Nutanix Cluster used to uniquely identify it. The 'name' value can be obtained from the 'deviceName' key in the JSON response of the listVirtualDevices API response. Pass the 'virtualDeviceType' parameter as 'Nutanix-Cluster' in the listVirtualDevices API to retrieve the corresponding virtual devices.	String	-	Yes

Sample Response

HTTP Code: 200

[
    {
        "CAPACITY": "1.15",
        "DISKS": 1,
        "SP_ID": 11,
        "NAME": "Test StoragePool"
    }
]

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=***************&name=nutanix-cluster

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API key to access your OpManager server.	String	-	Yes
name	Internal name of the managed Nutanix Cluster used to uniquely identify it. The 'name' value can be obtained from the 'deviceName' key in the JSON response of the listVirtualDevices API response. Pass the 'virtualDeviceType' parameter as 'Nutanix-Cluster' in the listVirtualDevices API to retrieve the corresponding virtual devices.	String	-	Yes

Sample Response

HTTP Code: 200

[
    {
        "CAPACITY": "800",
        "VG_ID": 18,
        "DISKS": 1,
        "NAME": "opm-vg1"
    },
    {
        "CAPACITY": "200",
        "VG_ID": 19,
        "DISKS": 1,
        "NAME": "Linux"
    },
    {
        "CAPACITY": "1529",
        "VG_ID": 20,
        "DISKS": 4,
        "NAME": "opm-vg2"
    },
    {
        "CAPACITY": "5",
        "VG_ID": 21,
        "DISKS": 1,
        "NAME": "opm-vg3"
    }
]

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=***************&name=nutanix.mydomain.com&type=Nutanix-Cluster

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API key to access your OpManager server.	String	-	Yes
name	Internal name of the managed Nutanix entity used to uniquely identify it. This value can be retrieved from the deviceName field in the listVirtualDevices API response. Pass virtualDeviceType as Nutanix-Cluster or Nutanix-Host in the listVirtualDevices API to retrieve the corresponding virtual devices.	String	-	Yes
type	Specifies the Nutanix entity type for which VM details should be retrieved.	String	Allowed values: 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/admin/getURLSummary?apiKey=***************&urlName=zoho_URL&snapType=MonitoringURL

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API key to access your OpManager server.	String	-	Yes
deviceName	Internal name of the device used to uniquely identify it. Can be used when the URL monitor is associated with a device.	String	-	No
urlName	Name of the URL monitor. The 'urlName' value can be obtained from the 'name' key in the JSON response of the listURLMonitors API response.	String	-	Yes
snapType	Used to identify the source of the request. The only allowed value is 'MonitoringURL'.	String	-	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=***************&app=AD

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API key to access your OpManager server.	String	-	Yes
app	The type of application for which service details are to be retrieved.	String	Allowed values: AD, Exchange, MSSQL	Yes
version	This parameter is required when the app type is 'Exchange' and is used to retrieve the respective services for the specified Exchange version..	Integer	Allowed values: 2003, 2007, 2010, 2013, 2016, 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.	String	-	Yes
isCustomMonitor	When set to true, filters the list to return only custom performance monitors.	Boolean	Allowed values: true, false	No
isCustFieldMonitor	When set to true, filters the list to return only custom field-based monitors.	Boolean	Allowed values: true, 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 VMware & Nutanix VM for real time health and performance updates.

HTTP Method

POST

API URL

https://localhost:8060/api/json/device/mapEntity?apiKey=***************&entityID=35&virtualType=VMware-VM&ipAddress=xxx.xxx.xxx.xxx

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API key to access your OpManager server.	String	-	Yes
entityID	Internal VM ID of the VM. This value can be retrieved from the VM_ID field in the getVMWareVMs API response for VMware VMs, or the getNutanixVMs API response for Nutanix VMs.	Long	-	Yes
virtualType	VMware or Nutanix VM virtualType to start monitoring it.	String	Allowed values: VMware-VM, Nutanix-VM	Yes
ipAddress	IP address or DNS name of the VM.	String	-	Yes

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.	String	-	Yes
diskID	Internal id of the VSAN disk used to uniquely identify it.	Long	-	Yes
enable	Specifies whether to enable or disable alarm notifications.	Boolean	Allowed Values: The input must exactly match either true or false	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 a VMware & Nutanix VM for real time health and performance updates.

HTTP Method

POST

API URL

https://localhost:8060/api/json/device/unmapEntity?apiKey=***************&entityID=35&virtualType=VMware-VM

Parameters

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API key to access your OpManager server.	String	-	Yes
entityID	Internal VM ID of the VM. This value can be retrieved from the VM_ID field in the getVMWareVMs API response for VMware VMs, or the getNutanixVMs API response for Nutanix VMs.	Long	-	Yes
virtualType	VMware or Nutanix VM virtualType to stop monitoring it.	String	Allowed values: VMware-VM, Nutanix-VM	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