Monitoring

getDeviceAssociatedMonitors

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/getDeviceAssociatedMonitors?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

{
  "performanceMonitors": {
    "total": 5,
    "statusIcon": "images/servicestatus5.gif",
    "down": 0,
    "monitors": [
      {
        "YAXISTEXT": "%",
        "checkNumeric": "true",
        "data": [
          {
            "instance": "-1",
            "value": 12
          }
        ],
        "Instance": "",
        "THRESHOLDENABLED": "true",
        "GRAPHID": "203",
        "type": "multiple",
        "thresholdImg": "images/thresholdConOK.gif",
        "suppressedMessage": "",
        "pollId": "10000000267",
        "Protocol": "WMI",
        "DISPLAYNAME": "CPU Utilization",
        "graphType": "multiple",
        "isSuppressed": "false",
        "policyName": "WMI-CPUUtilization",
        "dataType": "1",
        "active": "true",
        "thresholdStatus": "Normal",
        "isMultiple": "true",
        "sSave": "true",
        "pollingStatus": "0",
        "lastCollectedTime": "13 Aug 2026 01:35:50 PM IST",
        "groupName": "WMI",
        "DisplayColumn": "",
        "name": "WMI-CPUUtilization",
        "interval": "15",
        "numericType": "1",
        "Id": "10000000267"
      },
      {
        "YAXISTEXT": "%",
        "checkNumeric": "true",
        "data": [
          {
            "instance": "-1",
            "value": 56
          }
        ],
        "Instance": "",
        "THRESHOLDENABLED": "true",
        "GRAPHID": "204",
        "type": "multiple",
        "thresholdImg": "images/thresholdConOK.gif",
        "suppressedMessage": "",
        "pollId": "10000000271",
        "Protocol": "WMI",
        "DISPLAYNAME": "Memory Utilization",
        "graphType": "multiple",
        "isSuppressed": "false",
        "policyName": "WMI-MemoryUtilization",
        "dataType": "1",
        "active": "true",
        "thresholdStatus": "Normal",
        "isMultiple": "true",
        "sSave": "true",
        "pollingStatus": "0",
        "lastCollectedTime": "13 Aug 2026 01:35:49 PM IST",
        "groupName": "WMI",
        "DisplayColumn": "",
        "name": "WMI-MemoryUtilization",
        "interval": "15",
        "numericType": "1",
        "Id": "10000000271"
      },
      {
        "YAXISTEXT": "Percentage",
        "checkNumeric": "true",
        "data": [
          {
            "instance": "-1",
            "value": "8.2"
          }
        ],
        "Instance": "",
        "THRESHOLDENABLED": "false",
        "GRAPHID": "304",
        "type": "node",
        "thresholdImg": "images/thresholdNonConfigured.gif",
        "suppressedMessage": "",
        "pollId": "10000000269",
        "Protocol": "WMI",
        "DISPLAYNAME": "Partition Details of the Device(%)-C:",
        "graphType": "multiplenode",
        "isSuppressed": "false",
        "policyName": "WMI-PartitionDetails",
        "dataType": "3",
        "active": "true",
        "thresholdStatus": "Not Enabled",
        "isMultiple": "false",
        "sSave": "true",
        "pollingStatus": "0",
        "lastCollectedTime": "13 Aug 2026 12:52:59 PM IST",
        "groupName": "WMI",
        "DisplayColumn": "",
        "name": "C:",
        "interval": "60",
        "numericType": "3",
        "Id": "10000000269"
      }
    ]
  },
  "deviceProtocol": "WMI",
  "serverMonitors": {
    "total": 0,
    "down": 0,
    "monitors": []
  },
  "ntServiceMonitors": {
    "total": 0,
    "statusIcon": "images/servicestatus5.gif",
    "down": 0,
    "monitors": []
  },
  "urlMonitors": {
    "total": 0,
    "statusIcon": "images/servicestatus5.gif",
    "down": 0,
    "monitors": []
  },
  "processMonitors": {
    "total": 0,
    "statusIcon": "images/servicestatus5.gif",
    "down": 0,
    "monitors": []
  },
  "showPollingStatusColumn": true,
  "fileMonitors": {
    "total": 0,
    "statusIcon": "images/servicestatus5.gif",
    "down": 0,
    "monitors": []
  },
  "eventlogMonitors": {
    "period": "300",
    "total": 0,
    "statusIcon": "images/servicestatus5.gif",
    "isActive": "false",
    "down": 0,
    "monitors": []
  },
  "isDCMEnabled": true,
  "folderMonitors": {
    "total": 0,
    "statusIcon": "images/servicestatus5.gif",
    "down": 0,
    "monitors": []
  },
  "scriptMonitors": {
    "total": 0,
    "statusIcon": "images/servicestatus5.gif",
    "down": 0,
    "monitors": []
  }
}

Error Response

View common error responses

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

getPerformanceMonitors

Lists all the available performance monitors for a particular device (based on the device's category and type)

HTTP Method

GET

API URL

https://localhost:8060/api/json/device/getPerformanceMonitors?apiKey=***************&deviceName=opm-server.mydomain.com&category=Server&type=Windows%202025

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. This value can be retrieved from the deviceName field in the listDevices API response.	String	-	Yes
category	Category of the device like Server, Desktop etc. The 'category' value can be obtained from the 'category' key in the JSON response of the listDevices API.	String	Example: Server, Desktop	Yes
type	Type of the device like Windows 2025. The 'type' value can be obtained from the 'type' key in the JSON response of the listDevices API. Encode the value using URL encoding before passing it in the API request.	String	Example: Windows 2025	Yes

Sample Response

HTTP Code: 200

{
    "General Monitors": [
        {
            "DISPLAYNAME": "SysUpTime",
            "Description": "The time (in hundredths of a second) since the network management portion of the system was last re-initialized",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 1166,
            "name": "SysUpTime",
            "isSelected": "false",
            "interval": "900",
            "oid": "(.1.3.6.1.2.1.1.3.0/360000)",
            "Protocol": "SNMP",
            "thresholdEnabled": "false",
            "STANDARDNAME": "General Monitors"
        },
        {
            "DISPLAYNAME": "Network Interfaces",
            "Description": "The number of network interfaces (regardless of their current state) present on this system",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 1167,
            "name": "Number of Network Interfaces",
            "isSelected": "false",
            "interval": "3600",
            "oid": ".1.3.6.1.2.1.2.1.0",
            "Protocol": "SNMP",
            "thresholdEnabled": "false",
            "STANDARDNAME": "General Monitors"
        },
        {
            "DISPLAYNAME": "IP Routing discards",
            "Description": "The number of routing entries which were chosen to be discarded even though they are valid",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 1168,
            "name": "ipRoutingDiscards",
            "isSelected": "false",
            "interval": "3600",
            "oid": ".1.3.6.1.2.1.4.23.0",
            "Protocol": "SNMP",
            "thresholdEnabled": "false",
            "STANDARDNAME": "General Monitors"
        },
        {
            "DISPLAYNAME": "Host Resources SysUpTime (Days)",
            "Description": "The amount of time since this host was last initialized",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 5137,
            "name": "HRSysUpTimeInDays",
            "isSelected": "false",
            "interval": "900",
            "oid": "(.1.3.6.1.2.1.25.1.1.0/86400)",
            "Protocol": "SNMP",
            "thresholdEnabled": "false",
            "STANDARDNAME": "General Monitors"
        },
        {
            "DISPLAYNAME": "SNMP SysUpTime (Days)",
            "Description": "The number of seconds since the value of the snmpEngineBoots object last changed",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 5138,
            "name": "SnmpEngineSysUpTimeInDays",
            "isSelected": "false",
            "interval": "900",
            "oid": "(.1.3.6.1.6.3.10.2.1.3.0/86400)",
            "Protocol": "SNMP",
            "thresholdEnabled": "false",
            "STANDARDNAME": "General Monitors"
        },
        {
            "DISPLAYNAME": "SysUpTime(Days)",
            "Description": "The time (in hundredths of a second) since the network management portion of the system was last re-initialized in days",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 5139,
            "name": "SysUpTimeInDaysVendor",
            "isSelected": "false",
            "interval": "900",
            "oid": "(.1.3.6.1.2.1.1.3.0/8640000)",
            "Protocol": "SNMP",
            "thresholdEnabled": "false",
            "STANDARDNAME": "General Monitors"
        }
    ],
    "Performance Monitors": [
        {
            "DISPLAYNAME": "Logical Drive status",
            "Description": "Monitors the status of logical drives. KEY: 2 - Ok, 3 - Failed, 10 - Overheating, 11 - Shutdown, 13 - notAvailable",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 4974,
            "name": "Win-LogicalDriveStatus",
            "isSelected": "false",
            "interval": "900",
            "oid": ".1.3.6.1.4.1.232.3.2.3.1.1.4",
            "Protocol": "SNMP",
            "thresholdEnabled": "false",
            "isCustomGraph": "false"
        },
        {
            "DISPLAYNAME": "File Access Violations",
            "Description": "Monitors the number of access permission violations encountered on this server.",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 4975,
            "name": "Win-FileAccessViolations",
            "isSelected": "false",
            "interval": "900",
            "oid": ".1.3.6.1.4.1.77.1.2.10.0",
            "Protocol": "SNMP",
            "thresholdEnabled": "false",
            "isCustomGraph": "false"
        },
        {
            "DISPLAYNAME": "Number of System Errors",
            "Description": "Monitors the number of system errors encountered on the server.",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 4976,
            "name": "Win-NumberOfSystemErrors",
            "isSelected": "false",
            "interval": "900",
            "oid": ".1.3.6.1.4.1.77.1.2.11.0",
            "Protocol": "SNMP",
            "thresholdEnabled": "false",
            "isCustomGraph": "false"
        },
        {
            "DISPLAYNAME": "Number of installed services",
            "Description": "Monitors the number of network services installed on this server.",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 4977,
            "name": "Win-NumberOfInstalledServices",
            "isSelected": "false",
            "interval": "3600",
            "oid": ".1.3.6.1.4.1.77.1.2.2.0",
            "Protocol": "SNMP",
            "thresholdEnabled": "false",
            "isCustomGraph": "false"
        },
        {
            "DISPLAYNAME": "Number of Shared Resources",
            "Description": "Monitors the number of shared resources on this server.",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 4978,
            "name": "Win-NumberOfSharedResources",
            "isSelected": "false",
            "interval": "900",
            "oid": ".1.3.6.1.4.1.77.1.2.26.0",
            "Protocol": "SNMP",
            "thresholdEnabled": "false",
            "isCustomGraph": "false"
        },
        {
            "DISPLAYNAME": "Number of Opened Files",
            "Description": "Monitors the total number of files that have been opened on the server.",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 4979,
            "name": "Win-NumberOfOpenedFiles",
            "isSelected": "false",
            "interval": "900",
            "oid": ".1.3.6.1.4.1.77.1.2.4.0",
            "Protocol": "SNMP",
            "thresholdEnabled": "false",
            "isCustomGraph": "false"
        },
        {
            "DISPLAYNAME": "Number of Print Queued Jobs",
            "Description": "Monitors the total number of print jobs that have been spooled on the server.",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 4980,
            "name": "Win-NumberOfPrintQueuedJobs",
            "isSelected": "false",
            "interval": "900",
            "oid": ".1.3.6.1.4.1.77.1.2.6.0",
            "Protocol": "SNMP",
            "thresholdEnabled": "false",
            "isCustomGraph": "false"
        },
        {
            "DISPLAYNAME": "Number of Failed Logins",
            "Description": "Monitors the number of password violations encountered on the server.",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 4981,
            "name": "WinFailedLogins",
            "isSelected": "false",
            "interval": "900",
            "oid": ".1.3.6.1.4.1.77.1.2.9.0",
            "Protocol": "SNMP",
            "thresholdEnabled": "false",
            "isCustomGraph": "false"
        }
    ],
    "HOST-RESOURCES Monitors": [
        {
            "DISPLAYNAME": "CPU Utilization",
            "Description": "Monitors the CPU Utilization based on HOSTRESOURCE MIB",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 35,
            "name": "Win-CPUUtilization",
            "isSelected": "false",
            "interval": "900",
            "oid": ".1.3.6.1.2.1.25.3.3.1.2",
            "Protocol": "SNMP",
            "thresholdEnabled": "false",
            "STANDARDNAME": "HOST-RESOURCES Monitors"
        },
        {
            "DISPLAYNAME": "Memory Utilization",
            "Description": "Monitors the Memory Utilization",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 36,
            "name": "Win-MemoryUtilization",
            "isSelected": "false",
            "interval": "900",
            "oid": ".1.3.6.1.2.1.25.5.1.1.2",
            "Protocol": "SNMP",
            "thresholdEnabled": "false",
            "STANDARDNAME": "HOST-RESOURCES Monitors"
        },
        {
            "DISPLAYNAME": "Disk Utilization",
            "Description": "Monitors the Disk Utilization",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 37,
            "name": "DiskUtilization",
            "isSelected": "false",
            "interval": "3600",
            "oid": ".1.3.6.1.2.1.25.2.3.1.6",
            "Protocol": "SNMP",
            "thresholdEnabled": "false",
            "STANDARDNAME": "HOST-RESOURCES Monitors"
        },
        {
            "DISPLAYNAME": "Free Disk Space in GB",
            "Description": "Monitors the free disk space in GB using SNMP",
            "showAddPartitionOption": "true",
            "isNumeric": "true",
            "GRAPHID": 276,
            "name": "Win-FreeDiskSpaceInGB",
            "isSelected": "false",
            "interval": "3600",
            "oid": "(.1.3.6.1.2.1.25.2.3.1.4*(.1.3.6.1.2.1.25.2.3.1.5-.1.3.6.1.2.1.25.2.3.1.6))/(1073741824)",
            "Protocol": "SNMP",
            "thresholdEnabled": "false",
            "STANDARDNAME": "HOST-RESOURCES Monitors"
        },
        {
            "DISPLAYNAME": "Free Disk Space in MB",
            "Description": "Monitors the Free disk space in MB using SNMP",
            "showAddPartitionOption": "true",
            "isNumeric": "true",
            "GRAPHID": 277,
            "name": "Win-FreeDiskSpaceInMB",
            "isSelected": "false",
            "interval": "3600",
            "oid": "(.1.3.6.1.2.1.25.2.3.1.4*(.1.3.6.1.2.1.25.2.3.1.5-.1.3.6.1.2.1.25.2.3.1.6))/(1048576)",
            "Protocol": "SNMP",
            "thresholdEnabled": "false",
            "STANDARDNAME": "HOST-RESOURCES Monitors"
        },
        {
            "DISPLAYNAME": "Used Disk Space in GB",
            "Description": "Monitors the used disk space in GB",
            "showAddPartitionOption": "true",
            "isNumeric": "true",
            "GRAPHID": 278,
            "name": "Win-UsedDiskSpaceInGB",
            "isSelected": "false",
            "interval": "3600",
            "oid": "(.1.3.6.1.2.1.25.2.3.1.4*.1.3.6.1.2.1.25.2.3.1.6)/(1073741824)",
            "Protocol": "SNMP",
            "thresholdEnabled": "false",
            "STANDARDNAME": "HOST-RESOURCES Monitors"
        },
        {
            "DISPLAYNAME": "Used Disk Space in MB",
            "Description": "Monitors the used disk space in MB using SNMP",
            "showAddPartitionOption": "true",
            "isNumeric": "true",
            "GRAPHID": 279,
            "name": "Win-UsedDiskSpaceInMB",
            "isSelected": "false",
            "interval": "3600",
            "oid": "(.1.3.6.1.2.1.25.2.3.1.4*.1.3.6.1.2.1.25.2.3.1.6)/(1048576)",
            "Protocol": "SNMP",
            "thresholdEnabled": "false",
            "STANDARDNAME": "HOST-RESOURCES Monitors"
        },
        {
            "DISPLAYNAME": "Partition Details of the Device (%)",
            "Description": "Monitoring the usage in each partition of the Device.",
            "showAddPartitionOption": "true",
            "isNumeric": "true",
            "GRAPHID": 280,
            "name": "PartitionWiseDiskDetails",
            "isSelected": "false",
            "interval": "3600",
            "oid": "(.1.3.6.1.2.1.25.2.3.1.6*100/.1.3.6.1.2.1.25.2.3.1.5)",
            "Protocol": "SNMP",
            "thresholdEnabled": "false",
            "STANDARDNAME": "HOST-RESOURCES Monitors"
        },
        {
            "DISPLAYNAME": "CPU Utilization(UCD SNMP MIB)",
            "Description": "Monitors the CPU Utilization based on UCD SNMP MIB",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 330,
            "name": "Lin-CPUUtilization",
            "isSelected": "false",
            "interval": "900",
            "oid": ".1.3.6.1.4.1.2021.11.9.0",
            "Protocol": "SNMP",
            "thresholdEnabled": "false",
            "STANDARDNAME": "HOST-RESOURCES Monitors"
        },
        {
            "DISPLAYNAME": "Process Count",
            "Description": "Monitors the Number of Processes running in a machine.",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 375,
            "name": "ProcessCount",
            "isSelected": "false",
            "interval": "900",
            "oid": ".1.3.6.1.2.1.25.1.6.0",
            "Protocol": "SNMP",
            "thresholdEnabled": "false",
            "STANDARDNAME": "HOST-RESOURCES Monitors"
        },
        {
            "DISPLAYNAME": "Memory Utilization(UCD SNMP MIB)",
            "Description": "Monitors the Memory utilization based on UCD SNMP MIB",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 549,
            "name": "Lin-MemoryUtilization",
            "isSelected": "false",
            "interval": "900",
            "oid": "(.1.3.6.1.4.1.2021.4.5.0-.1.3.6.1.4.1.2021.4.6.0-.1.3.6.1.4.1.2021.4.14.0-.1.3.6.1.4.1.2021.4.15.0)*100/.1.3.6.1.4.1.2021.4.5.0",
            "Protocol": "SNMP",
            "thresholdEnabled": "false",
            "STANDARDNAME": "HOST-RESOURCES Monitors"
        }
    ],
    "Server Monitors": [
        {
            "DISPLAYNAME": "Bytes Received",
            "Description": "Number of bytes the server has received from the network. This property indicates how busy the server is",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 682,
            "name": "BytesReceivedPerSec",
            "isSelected": "false",
            "interval": "900",
            "oid": "Server.BytesReceivedPerSec",
            "Protocol": "WMI",
            "thresholdEnabled": "false",
            "isCustomGraph": "false"
        },
        {
            "DISPLAYNAME": "Bytes Transmitted",
            "Description": "Number of bytes the server has received from the network. This property indicates how busy the server is",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 683,
            "name": "BytesTransmittedPerSec",
            "isSelected": "false",
            "interval": "900",
            "oid": "Server.BytesTransmittedPerSec",
            "Protocol": "WMI",
            "thresholdEnabled": "false",
            "isCustomGraph": "false"
        },
        {
            "DISPLAYNAME": "Bytes Total",
            "Description": "Number of bytes the server has sent to and received from the network, an overall indication of how busy the server is",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 684,
            "name": "BytesTotalPerSec",
            "isSelected": "false",
            "interval": "900",
            "oid": "Server.BytesTotalPerSec",
            "Protocol": "WMI",
            "thresholdEnabled": "false",
            "isCustomGraph": "false"
        },
        {
            "DISPLAYNAME": "Active Remote Desktop Connections",
            "Description": "Monitors the number of sessions that are currently connected where the user has logged in.",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 4909,
            "name": "WMI-ActiveRemoteDesktopConnections",
            "isSelected": "false",
            "interval": "3600",
            "oid": "WMI-ActiveRemoteDesktopConnections",
            "Protocol": "WMI",
            "thresholdEnabled": "false",
            "isCustomGraph": "false"
        },
        {
            "DISPLAYNAME": "Inactive Remote Desktop Connections",
            "Description": "Monitors number of sessions that are waiting for the initial connection and waiting for users to log in, or where the session has been disconnected but a user is logged in.",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 4912,
            "name": "WMI-InactiveRemoteDesktopConnections",
            "isSelected": "false",
            "interval": "900",
            "oid": "WMI-InactiveRemoteDesktopConnections",
            "Protocol": "WMI",
            "thresholdEnabled": "false",
            "isCustomGraph": "false"
        },
        {
            "DISPLAYNAME": "Total Remote Desktop Connections",
            "Description": "Monitors the total number of sessions recorded on the server.",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 4913,
            "name": "WMI-TotalRemoteDesktopConnections",
            "isSelected": "false",
            "interval": "900",
            "oid": "WMI-TotalRemoteDesktopConnections",
            "Protocol": "WMI",
            "thresholdEnabled": "false",
            "isCustomGraph": "false"
        }
    ],
    "System Monitors": [
        {
            "DISPLAYNAME": "File Read Operations",
            "Description": "Combined rate of file system read requests to all devices on the computer, including requests to read from the file system cache",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 676,
            "name": "FileReadOperationsPerSec",
            "isSelected": "false",
            "interval": "900",
            "oid": "System.FileReadOperationsPerSec",
            "Protocol": "WMI",
            "thresholdEnabled": "false",
            "isCustomGraph": "false"
        },
        {
            "DISPLAYNAME": "File Write Operations",
            "Description": "Combined rate of the file system write requests to all devices on the computer, including requests to write to data in the file system cache",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 677,
            "name": "FileWriteOperationsPerSec",
            "isSelected": "false",
            "interval": "900",
            "oid": "System.FileWriteOperationsPerSec",
            "Protocol": "WMI",
            "thresholdEnabled": "false",
            "isCustomGraph": "false"
        },
        {
            "DISPLAYNAME": "File Read Bytes",
            "Description": "Overall rate at which bytes are read to satisfy file system read requests to all devices on the computer, including read requests from the file system cache",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 678,
            "name": "FileReadBytesPerSec",
            "isSelected": "false",
            "interval": "900",
            "oid": "System.FileReadBytesPerSec",
            "Protocol": "WMI",
            "thresholdEnabled": "false",
            "isCustomGraph": "false"
        },
        {
            "DISPLAYNAME": "File Write Bytes",
            "Description": "Overall rate at which bytes are written to satisfy file system write requests to all devices on the computer, including write requests to the file system cache",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 679,
            "name": "FileWriteBytesPerSec",
            "isSelected": "false",
            "interval": "900",
            "oid": "System.FileWriteBytesPerSec",
            "Protocol": "WMI",
            "thresholdEnabled": "false",
            "isCustomGraph": "false"
        },
        {
            "DISPLAYNAME": "Processor Queue Length",
            "Description": "Number of threads in the processor queue",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 680,
            "name": "SystemProcessorQueueLength",
            "isSelected": "false",
            "interval": "900",
            "oid": "System.ProcessorQueueLength",
            "Protocol": "WMI",
            "thresholdEnabled": "false",
            "isCustomGraph": "false"
        },
        {
            "DISPLAYNAME": "ContextSwitches",
            "Description": "Rate of switches from one thread to another. Thread switches can occur either inside of a single process or across processes",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 681,
            "name": "ContextSwitchesPerSec",
            "isSelected": "false",
            "interval": "900",
            "oid": "System.ContextSwitchesPerSec",
            "Protocol": "WMI",
            "thresholdEnabled": "false",
            "isCustomGraph": "false"
        },
        {
            "DISPLAYNAME": "File System Bytes Read",
            "Description": "Monitors the total number of bytes read by the File System from disk drive.",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 4916,
            "name": "WMI-FileSystemBytesRead",
            "isSelected": "false",
            "interval": "900",
            "oid": "WMI-FileSystemBytesRead",
            "Protocol": "WMI",
            "thresholdEnabled": "false",
            "isCustomGraph": "false"
        },
        {
            "DISPLAYNAME": "File System Bytes Written",
            "Description": "Monitors the total number of bytes written by the File System from disk drive.",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 4917,
            "name": "WMI-FileSystemBytesWritten",
            "isSelected": "false",
            "interval": "900",
            "oid": "WMI-FileSystemBytesWritten",
            "Protocol": "WMI",
            "thresholdEnabled": "false",
            "isCustomGraph": "false"
        }
    ],
    "Processor Monitors": [
        {
            "DISPLAYNAME": "Privileged Time",
            "Description": "Percentage of non-idle processor time spent in privileged mode",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 685,
            "name": "PercentPrivilegedTime",
            "isSelected": "false",
            "interval": "900",
            "oid": "Processor.PercentPrivilegedTime",
            "Protocol": "WMI",
            "thresholdEnabled": "false",
            "isCustomGraph": "false"
        },
        {
            "DISPLAYNAME": "Processor Time",
            "Description": "Percentage of time that the processor is executing a non-idle thread",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 686,
            "name": "PercentProcessorTime",
            "isSelected": "false",
            "interval": "900",
            "oid": "Processor.PercentProcessorTime",
            "Protocol": "WMI",
            "thresholdEnabled": "false",
            "isCustomGraph": "false"
        },
        {
            "DISPLAYNAME": "User Time",
            "Description": "Percentage of non-idle processor time spent in user mode",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 687,
            "name": "PercentUserTime",
            "isSelected": "false",
            "interval": "900",
            "oid": "Processor.PercentUserTime",
            "Protocol": "WMI",
            "thresholdEnabled": "false",
            "isCustomGraph": "false"
        },
        {
            "DISPLAYNAME": "Idle Time",
            "Description": "Percentage of time during the sample interval that the processor was idle. Not applicable for Windows XP and Windows 2000 devices.",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 688,
            "name": "PercentIdleTime",
            "isSelected": "false",
            "interval": "900",
            "oid": "Processor.PercentIdleTime",
            "Protocol": "WMI",
            "thresholdEnabled": "false",
            "isCustomGraph": "false"
        },
        {
            "DISPLAYNAME": "CPU Interrupts per second",
            "Description": "The numbers of interrupts the processor need to respond in a Second",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 2249,
            "name": "WMICPUInterruptsPerSec",
            "isSelected": "false",
            "interval": "900",
            "oid": "CPU Interrupts Per Sec",
            "Protocol": "WMI",
            "thresholdEnabled": "false",
            "isCustomGraph": "false"
        },
        {
            "DISPLAYNAME": "CPU Interrupts %",
            "Description": "Percentage of time that the processor is spending on handling Interrupts",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 2250,
            "name": "WMIPercentInterruptTime",
            "isSelected": "false",
            "interval": "900",
            "oid": "CPU Interrupts Percent",
            "Protocol": "WMI",
            "thresholdEnabled": "false",
            "isCustomGraph": "false"
        },
        {
            "DISPLAYNAME": "Run Queue Length of CPU",
            "Description": "The Run Queue length of the CPU",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 2251,
            "name": "WMIRunQueueLengthofCPU",
            "isSelected": "false",
            "interval": "900",
            "oid": "Run Queue Length of CPU",
            "Protocol": "WMI",
            "thresholdEnabled": "false",
            "isCustomGraph": "false"
        },
        {
            "DISPLAYNAME": "Percent DPC Time",
            "Description": "Percentage of time that the processor spent receiving and servicing deferred procedure calls during the sample interval",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 2252,
            "name": "WMIPercentDPCTime",
            "isSelected": "false",
            "interval": "3600",
            "oid": "WMI Percent DPC Time",
            "Protocol": "WMI",
            "thresholdEnabled": "false",
            "isCustomGraph": "false"
        },
        {
            "DISPLAYNAME": "System Calls per second",
            "Description": "Rate of calls to Windows system service routines by all processes running on the computer",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 2253,
            "name": "WMISystemCallsPersec",
            "isSelected": "false",
            "interval": "900",
            "oid": "WMI System Calls Persec",
            "Protocol": "WMI",
            "thresholdEnabled": "false",
            "isCustomGraph": "false"
        },
        {
            "DISPLAYNAME": "System UpTime in minutes",
            "Description": "Number of minutes the computer has been running after it was last started",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 2254,
            "name": "WMISystemUpTime",
            "isSelected": "false",
            "interval": "900",
            "oid": "WMI System UpTime",
            "Protocol": "WMI",
            "thresholdEnabled": "false",
            "isCustomGraph": "false"
        },
        {
            "DISPLAYNAME": "CPU Utilization Per Core",
            "Description": "Monitors the CPU Utilization percentage of individual CPU Cores.",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 4908,
            "name": "WMI-CPU_UtilizationPerCore",
            "isSelected": "false",
            "interval": "900",
            "oid": "WMI-CPUUtilizationPerCore",
            "Protocol": "WMI",
            "thresholdEnabled": "false",
            "isCustomGraph": "false"
        },
        {
            "DISPLAYNAME": "System UpTime in Days",
            "Description": "Number of days the computer has been running since it was last started",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 5000,
            "name": "WMISystemUpTimeInDays",
            "isSelected": "false",
            "interval": "900",
            "oid": "WMI System UpTime In Days",
            "Protocol": "WMI",
            "thresholdEnabled": "false",
            "isCustomGraph": "false"
        }
    ],
    "Custom Monitor": [],
    "Exchange 5.5 Monitors": [
        {
            "DISPLAYNAME": "Non-delivery Reports (Total Outbound)",
            "Description": "Monitors the total outbound non-delivery report",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 321,
            "name": "ImsNDRsTotalOutbound",
            "isSelected": "false",
            "interval": "900",
            "oid": ".1.3.6.1.4.1.311.1.1.3.1.1.3.17.0",
            "Protocol": "SNMP",
            "thresholdEnabled": "false",
            "isCustomGraph": "false"
        },
        {
            "DISPLAYNAME": "Non-delivery Reports (Total Inbound)",
            "Description": "Monitors the total inbound non-delivery report",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 322,
            "name": "ImsNDRsTotalInbound",
            "isSelected": "false",
            "interval": "900",
            "oid": ".1.3.6.1.4.1.311.1.1.3.1.1.3.16.0",
            "Protocol": "SNMP",
            "thresholdEnabled": "false",
            "isCustomGraph": "false"
        },
        {
            "DISPLAYNAME": "Total Msgs (awaiting final delivery)",
            "Description": "Monitors the total awaiting messages for delivery",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 323,
            "name": "ImsQueuedMTS-IN",
            "isSelected": "false",
            "interval": "900",
            "oid": ".1.3.6.1.4.1.311.1.1.3.1.1.3.1.0",
            "Protocol": "SNMP",
            "thresholdEnabled": "false",
            "isCustomGraph": "false"
        },
        {
            "DISPLAYNAME": "Total Size of the Msgs (awaiting final delivery)",
            "Description": "Monitors the total size of the awaiting messages for delivery",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 324,
            "name": "ImsBytesQueuedMTS-IN",
            "isSelected": "false",
            "interval": "900",
            "oid": ".1.3.6.1.4.1.311.1.1.3.1.1.3.2.0",
            "Protocol": "SNMP",
            "thresholdEnabled": "false",
            "isCustomGraph": "false"
        },
        {
            "DISPLAYNAME": "Inbound Connection Rate",
            "Description": "Monitors the inbound connection rate",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 325,
            "name": "InboundConnectionsPerHr",
            "isSelected": "false",
            "interval": "900",
            "oid": ".1.3.6.1.4.1.311.1.1.3.1.1.3.27.0",
            "Protocol": "SNMP",
            "thresholdEnabled": "false",
            "isCustomGraph": "false"
        },
        {
            "DISPLAYNAME": "Outbound Connection Rate",
            "Description": "Monitors the outbound connection rate",
            "showAddPartitionOption": "false",
            "isNumeric": "true",
            "GRAPHID": 326,
            "name": "OutboundConnectionsPerHr",
            "isSelected": "false",
            "interval": "900",
            "oid": ".1.3.6.1.4.1.311.1.1.3.1.1.3.26.0",
            "Protocol": "SNMP",
            "thresholdEnabled": "false",
            "isCustomGraph": "false"

Error Response

View common error responses

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

getLastCollectedValues

Retrieves the last collected monitor values for all devices in a specified device group or a list of device MOIDs. For each device, the response includes the most recently polled data from all active monitors - such as performance monitors (CPU, memory, disk, interface traffic), script monitors, and other polling-based monitors, along with associated metadata including monitor policy name, OID, threshold settings, polling status, and graph display details.

HTTP Method

GET

API URL

https://localhost:8060/api/json/device/getLastCollectedValues?apiKey=***************&deviceMOIDList=1802,1804

https://localhost:8060/api/json/device/getLastCollectedValues?apiKey=***************&groupName=test-1803

Parameters

Note:

While deviceMOIDList, groupName are each marked as not mandatory, at least one of the two must be provided in the request.
If both deviceMOIDList and groupName are specified, the API retrieves the last collected values for all monitors associated with the devices in the specified device groups, and the deviceMOIDList parameter is ignored.
It is recommended to pass up to 500 elements in the deviceMOIDList param.

Param Name	Description	Data Type	Additional Information	Is Mandatory
apiKey	API key to access your OpManager server.	String	-	Yes
deviceMOIDList	Internal id of the device used to uniquely identify it. Multiple moid can be specified as comma-separated list. The 'moid' value can be obtained from the 'moid' key in the JSON response of the listDevices API.	Long (comma-separated)	-	No
groupName	Internal name used to identify a device group. The 'groupName' value can be obtained from the 'groupName' key in the JSON response of the listAllLogicalGroups API.	String	-	No
eeProbeID	Internal id of the probe used to uniquely identify it. The 'eeProbeID' value can be obtained from the 'probeID' key in the JSON response of the listProbes API.	Long	This parameter is mandatory to get the data from OpManager Central.	No

Sample Response

HTTP Code: 200

{
  "902": [
    {
      "NumericType": 1,
      "ProtocolName": "WMI",
      "Description": "Monitors the Disk Utilization using WMI",
      "GraphName": "WMI-DiskUtilization",
      "GraphTypeName": "multiple",
      "data": [
        {
          "instance": "-1",
          "value": 72
        }
      ],
      "GraphId": 205,
      "PollId": 3161,
      "OID": "Disk Utilization",
      "previousSeverity": 5,
      "YAxisText": "%",
      "deviceName": "opm-server.mydomain.com",
      "lastCollectedTime": "17 Aug 2026 03:37:46 PM IST",
      "failureThreshold": 1,
      "PolicyName": "WMI-DiskUtilization",
      "lastPolledCounterValue": 0,
      "DataType": "1",
      "failureCount": 0
    },
    {
      "NumericType": 1,
      "ProtocolName": "WMI",
      "Description": "Monitors the Memory Utilization using WMI",
      "GraphName": "WMI-MemoryUtilization",
      "GraphTypeName": "multiple",
      "data": [
        {
          "instance": "-1",
          "value": 52
        }
      ],
      "GraphId": 204,
      "PollId": 3162,
      "OID": "Memory Utilization",
      "previousSeverity": 5,
      "YAxisText": "%",
      "deviceName": "opm-server.mydomain.com",
      "lastCollectedTime": "17 Aug 2026 04:07:48 PM IST",
      "failureThreshold": 1,
      "PolicyName": "WMI-MemoryUtilization",
      "lastPolledCounterValue": 0,
      "DataType": "1",
      "failureCount": 0
    },
    {
      "NumericType": 3,
      "ProtocolName": "WMI",
      "Description": "Monitoring the usage in each partition of the Device using WMI.",
      "GraphName": "WMI-PartitionDetails",
      "GraphTypeName": "multiplenode",
      "data": [
        {
          "instance": "-1",
          "value": "71.8"
        }
      ],
      "GraphId": 304,
      "PollId": 3163,
      "OID": "Partition Details of the Device",
      "previousSeverity": 5,
      "YAxisText": "Percentage",
      "deviceName": "opm-server.mydomain.com",
      "lastCollectedTime": "17 Aug 2026 03:37:46 PM IST",
      "failureThreshold": 1,
      "PolicyName": "WMI-PartitionDetails",
      "lastPolledCounterValue": 0,
      "DataType": "1",
      "failureCount": 0
    },
    {
      "NumericType": 1,
      "ProtocolName": "WMI",
      "Description": "Number of minutes the computer has been running after it was last started",
      "GraphName": "WMISystemUpTime",
      "GraphTypeName": "node",
      "data": [
        {
          "instance": "-1",
          "value": 7859
        }
      ],
      "GraphId": 2254,
      "PollId": 3166,
      "OID": "WMI System UpTime",
      "previousSeverity": 5,
      "YAxisText": "Minutes",
      "deviceName": "opm-server.mydomain.com",
      "lastCollectedTime": "17 Aug 2026 04:07:48 PM IST",
      "failureThreshold": 1,
      "PolicyName": "WMISystemUpTime",
      "lastPolledCounterValue": 0,
      "DataType": "1",
      "failureCount": 0
    },
    {
      "NumericType": 1,
      "ProtocolName": "WMI",
      "Description": "Monitors the CPU Utilization using WMI",
      "GraphName": "WMI-CPUUtilization",
      "GraphTypeName": "multiple",
      "data": [
        {
          "instance": "-1",
          "value": 24
        }
      ],
      "GraphId": 203,
      "PollId": 3167,
      "OID": "CPU Utilization ProcessorInformation",
      "previousSeverity": 5,
      "YAxisText": "%",
      "deviceName": "opm-server.mydomain.com",
      "lastCollectedTime": "17 Aug 2026 04:07:49 PM IST",
      "failureThreshold": 1,
      "PolicyName": "WMI-CPUUtilization",
      "lastPolledCounterValue": 0,
      "DataType": "1",
      "failureCount": 0
    }
  ]
}

Error Response

View common error responses

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

getPerformanceMonitorDetails

Fetches detailed information about performance monitors for a specific device

HTTP Method

GET

API URL

http://localhost:8070/api/json/device/getPerformanceMonitorDetails?apiKey=********&name=testmachine&policyName=WMI-CPUUtilization&pollId=10000000197&checkNumeric=true

Parameters

Note: While pollId, graphName are each marked as not mandatory, at least one of the two 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
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 getDeviceAssociatedMonitors 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 'pollId' key in the JSON response of the getDeviceAssociatedMonitors API.	Long	-	No
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 getDeviceAssociatedMonitors API.	Boolean	-	Yes
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
instance	Internal name used to identify availability instance of a monitor.	String	Allowed Values: The input must contain one of the following - Url, Device, Packet_Loss	No
type	Internal name used to identify the type of the monitor.	String	Allowed Values: hardwareMonitors	No
sensorId	Internal id of the hardware sensor used to uniquely identify it. This parameter is mandatory when the type parameter is specified.	String	-	No

Sample Response

HTTP Code: 200

{ "statsList": [ { "minimumValue": "84", "averageValue": "85", "instance": "PhysicalMemUtilization", "percentile": "85", "lastPolledValue": "86", "maximumValue": "86"} ], "monitors":{ "YAXISTEXT": "Percentage", "checkNumeric": "true", "Description": "Monitors the Memory Utilization using WMI", "Instance": "", "THRESHOLDENABLED": "true", "GRAPHID": "204", "oid": "Memory Utilization", "type": "multiple", "PREVIOUSSEVERITY": "5", "defaultMessage_AT": "$MONITOR is $CURRENTVALUE $UNITS,Expected value for this monitor is $EXPECTEDVALUE $UNITS, current adaptive threshold is $THRESHOLDVALUE $UNITS", "defaultMessage": "$MONITOR is $CURRENTVALUE%, threshold value for this monitor is $THRESHOLDVALUE%", "id": "125", "Protocol": "WMI", "FAILURETHRESHOLD": "1", "DISPLAYNAME": "Memory Utilization", "thresholdSet": [ { "severity": "2", "clrMessage": "$MONITOR is now back to normal, current value is $CURRENTVALUE $UNITS", "troubleThresholdType": "max", "troubleThresholdName": "1668514350868814042", "troubleMessage": "$MONITOR is $CURRENTVALUE $UNITS,Expected value for this monitor is $EXPECTEDVALUE $UNITS, current adaptive threshold is $THRESHOLDVALUE $UNITS", "oidType": "", "rearmValue": "0", "troubleThresholdValue": "15"}, { "severity": "1", "clrMessage": "$MONITOR is now back to normal, current value is $CURRENTVALUE $UNITS", "criticalThresholdName": "1668514350869567781", "criticalMessage": "$MONITOR is $CURRENTVALUE $UNITS,Expected value for this monitor is $EXPECTEDVALUE $UNITS, current adaptive threshold is $THRESHOLDVALUE $UNITS", "criticalThresholdValue": "20", "oidType": "", "rearmValue": "0", "isAtEnabled": true, "criticalThresholdType": "max"}, { "severity": "3", "clrMessage": "$MONITOR is now back to normal, current value is $CURRENTVALUE $UNITS", "warningThresholdName": "1668514350867431743", "warningMessage": "$MONITOR is $CURRENTVALUE $UNITS,Expected value for this monitor is $EXPECTEDVALUE $UNITS, current adaptive threshold is $THRESHOLDVALUE $UNITS", "warningThresholdType": "max", "oidType": "", "warningThresholdValue": "10", "rearmValue": "0", "isAtEnabled": true} ], "graphType": "multiple", "policyName": "WMI-MemoryUtilization", "agentName": "localhost", "isMultiple": "true", "sSave": "true", "defaultClrMessage": "$MONITOR is now back to normal, current value is $CURRENTVALUE%", "DisplayColumn": "", "name": "WMI-MemoryUtilization", "numericType": "1", "interval": "15", "Id": "125", "isAtEnabled": true}}

Error Response

View common error responses

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

addPerformanceMonitors

Adds a new performance monitor (or multiple performance monitors) to the device

HTTP Method

POST

API URL

https://localhost:8060/api/json/device/addPerformanceMonitors?apiKey=***************&name=devicename&selectedMonitors=1166,3337,304,204,205,203,3327

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
selectedMonitors	Internal Id of the performance monitor that needs to be associated with the device. Multiple IDs can be specified as comma-separated list. The monitor IDs for selected monitors can be obtained from 'GRAPHID' key in the JSON response of the getPerformanceMonitors API.	String	-	Yes
processExistingPartitionMonitors	Indicates whether newly discovered partitions for existing partition-based monitors should be automatically added for monitoring.	Boolean	This is applicable only when a partition-based monitor is already associated with the device and new partitions need to be added for monitoring.	No

Sample Response

HTTP Code: 200

{ "result":{ "message": "Monitor added successfully"}}

Error Response

View common error responses

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

deletePerformanceMonitors

Deletes performance monitor(s) from the device

HTTP Method

POST

API URL

https://localhost:8060/api/json/device/deletePerformanceMonitors?apiKey=***************&name=devicename&pollId=332,213

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
pollId	Internal id of the monitor used to uniquely identify it. Multiple poll IDs can be specified as comma-separated list. The 'pollId' value can be obtained from the 'pollId' key in the JSON response of the getDeviceAssociatedMonitors API.	Integer (comma-separated)	-	Yes

Sample Response

HTTP Code: 200

{ "result":{ "message": "The monitor(s) will be deleted. Please check after sometime."}}

Error Response

View common error responses

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

TestMonitor

This API directly accesses the device to collect the required data and returns the results. Note: If you're looking for last collected values of performance monitors, 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

POST

API URL

http://localhost:8070/api/json/device/TestMonitor?apiKey=********&name=testmachine&policyName=WMI-CPUUtilization&pollId=10000000197

Parameters

Note: While pollId, graphName are each marked as not mandatory, at least one of the two 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
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 getDeviceAssociatedMonitors 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 'pollId' key in the JSON response of the getDeviceAssociatedMonitors API.	Long	-	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

Sample Response

HTTP Code: 200

{ "protocol": "SNMP", "checkNumeric": "true", "reasons": [], "monitorname": "Win-MemoryUtilization", "data": [ 89 ], "displayName": "Memory Utilization", "isMultiple": "false", "oid": ".1.3.6.1.2.1.25.5.1.1.2", "units": "Percentage", "deviceName": "localhost"}

Error Response

View common error responses

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

getAssociatedProcessMonitors

Retrieves the list of process monitor templates, the process monitors currently associated with the specified device, and the active processes currently running on the monitored machine.

HTTP Method

GET

API URL

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

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. The 'deviceName' value can be obtained from the 'deviceName' key in the JSON response of the listDevices API.	String	-	Yes

Sample Response

HTTP Code: 200

{ "protocol": "WMI", "Templates": [ { "protocol": "CLI", "associatedDeviceCount": "0", "templateName": "httpd", "displayName": "httpd", "description": "Process Template for httpd", "templateId": "2"}, { "protocol": "WMI", "associatedDeviceCount": "2", "templateName": "sqlservr.exe", "displayName": "MSSQL", "description": "Process Template for MSSQL", "templateId": "1"} ], "AssignedMonitors": [ { "path": "C:\\Program Files\\Microsoft SQL Server\\MSSQL\\Binn\\sqlservr.exe", "statusStr": "Clear", "cmdLineArgs": "", "statusIcon": "/webclient/devices/images/servicestatus5.gif", "name": "MSSQL", "state": "1", "id": "611", "proName": "sqlservr.exe", "trimName": "MSSQL", "status": "5", "statusNum": "5"} ], "ActiveProcesses":{ "7244":{ "path": "C:\\Windows\\System32\\msdtc.exe", "trimArgs": "", "trimPath": "C:\\Windows\\System32\\msdtc.exe", "cmdLineArgs": "", "name": "msdtc.exe", "trimName": "msdtc.exe"}, "3680":{ "path": "C:\\Windows\\system32\\SearchIndexer.exe", "trimArgs": "/Embedding", "trimPath": "C:\\Windows\\system32\\SearchIndexer.exe", "cmdLineArgs": "/Embedding", "name": "SearchIndexer.exe", "trimName": "SearchIndexer.exe"}, "4692":{ "path": "-", "trimArgs": "", "trimPath": "-", "cmdLineArgs": "", "name": "csrss.exe", "trimName": "csrss.exe"}, "1473196":{ "path": "C:\\Program Files (x86)\\DesktopCentral_Agent\\appctrl\\bin\\DriverCtrl.exe", "trimArgs": " ", "trimPath": "C:\\Program Files (x86)\\DesktopCentral_Ag...", "cmdLineArgs": " ", "name": "DriverCtrl.exe", "trimName": "DriverCtrl.exe"}, "4652":{ "path": "C:\\Windows\\system32\\winlogon.exe", "trimArgs": "winlogon.exe", "trimPath": "C:\\Windows\\system32\\winlogon.exe", "cmdLineArgs": "winlogon.exe", "name": "winlogon.exe", "trimName": "winlogon.exe"}}, "deviceName": "localhost"}

Error Response

View common error responses

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

associateProcessMonitor

Associates process monitor(s) to a device

HTTP Method

POST

API URL

https://localhost:8060/api/json/device/associateProcessMonitor?apiKey=***************&deviceName=devicename&processId=408,8,68&protocol=WMI

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. The 'deviceName' value can be obtained from the 'deviceName' key in the JSON response of the listDevices API.	String	-	Yes
protocol	Monitoring protocol associated with the device. The 'protocol' value can be obtained from the 'protocol' key in the JSON response of the getAssociatedProcessMonitors API.	String	Allowed Values: The input must contain one of the following - WMI, CLI, SNMP	Yes
processId	ID of the process to be associated. Multiple process IDs can be specified as comma-separated list. The processIds can be taken from the 'ActiveProcesses' key in the JSON response of the getAssociatedProcessMonitors API.	Integer (comma-separated)	The process IDs can also be obtained from the process details in the task manager of the monitored machine.	Yes

Sample Response

HTTP Code: 200

{ "result":{ "message": "Process monitor(s) associated successfully."}}

Error Response

View common error responses

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

getAssociatedServiceMonitors

Retrieves the list of service monitors currently associated with the specified device, along with the remaining service monitors that are available for association.

HTTP Method

GET

API URL

https://localhost:8060/api/json/device/getAssociatedServiceMonitors?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

{ "remainingServices": [ "DNS(53)", "Echo(7)", "FTP(21)" ], "selectedServices": [ "SMTP(25)", "Telnet(23)" ]}

Error Response

View common error responses

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

associateServiceMonitor

Associates service monitor(s) to a device

HTTP Method

POST

API URL

https://localhost:8060/api/json/admin/associateServiceMonitor?apiKey=***************&deviceName=opm-server.mydomain.com&serviceName=DNS,FTP,Echo

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. Multiple device names can be specified as comma-separated list. The 'deviceName' value can be obtained from the 'deviceName' key in the JSON response of the listDevices API.	String	-	Yes
serviceName	Name of the service monitors to be associated. Multiple service monitor names can be specified as comma-separated list. The 'serviceName' value can be obtained from the 'remainingServices' key in the JSON response of the getAssociatedServiceMonitors API.	String	-	Yes

Sample Response

HTTP Code: 200

{ "result":{ "message": "Service Monitor associated successfully"}}

Error Response

View common error responses

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

listURLMonitors

Lists URL monitors, representing globally defined URL monitors.

HTTP Method

GET

API URL

https://localhost:8060/api/json/admin/listURLMonitors?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

{ "List": [ { "availPercentage": 0, "urlName": "ManageEngine", "statusStr": "Service Down", "name": "ManageEngine_URL", "RESPONSETIME": "No Response", "url": "https://www.manageengine.com", "moID": 961, "statusNum": 4}, { "availPercentage": 0, "urlName": "HTTP Url", "statusStr": "Service Down", "name": "HTTP Url_URL", "RESPONSETIME": "No Response", "url": "http://localhost:8060", "moID": 996, "statusNum": 4}, { "availPercentage": 0, "urlName": "HTTPS Url", "statusStr": "Service Down", "name": "HTTPS Url_URL", "RESPONSETIME": "No Response", "url": "https://www.zoho.com", "moID": 997, "statusNum": 4} ], "Details":{ "00-10%": [ { "Status": 4, "Label": "Service Down", "Count": 6} ]}, "DialCounter": [ { "title": "Service Down", "value": 6, "status": 4} ]}

Error Response

View common error responses

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

listAllDevicesSpecificURLs

Identifies and lists URL monitors associated with individual devices, scoped to individual devices rather than applied globally.

HTTP Method

GET

API URL

https://localhost:8060/api/json/device/listAllDevicesSpecificURLs?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

{ "List": [ { "parentName": "localhost", "urlName": "URL_1", "stringstatus": "Clear", "parentDispName": "localhost", "name": "URL_1_URL", "url": "https://manageengine.com", "status": "5", "statusNum": "5"}, { "parentName": "localhost", "urlName": "URL_2", "stringstatus": "Clear", "parentDispName": "localhost", "name": "URL_2_URL", "url": "https://manageengine.com", "status": "5", "statusNum": "5"} ]}

Error Response

View common error responses

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

listScriptMonitors

Retrieves the list of all script templates created in OpManager.

HTTP Method

GET

API URL

https://localhost:8060/api/json/admin/listScriptMonitors?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

[ { "graphName": "Cache Memory", "scriptID": "102", "executeFrom": "1", "graphDesc": "Perl Script to get cache memory of a linux system", "graphID": "1207"}, { "graphName": "File Size", "scriptID": "103", "executeFrom": "1", "graphDesc": "Shell script to get memory size of a file in linux system", "graphID": "1208"}, { "graphName": "Instance Count", "scriptID": "101", "executeFrom": "0", "graphDesc": "VBScript to get number of instances running for a given process", "graphID": "1206"}, { "graphName": "Thread Count", "scriptID": "104", "executeFrom": "0", "graphDesc": "Powershell script to get thread count of a process", "graphID": "1209"}]

Error Response

View common error responses

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