Home
 

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=devicename

Parameters

Param NameDescriptionData TypeAdditional InformationIs Mandatory
apiKeyAPI Key to access your OpManager server.String-Yes
name Click here to learn how to get the Device NameString-Yes

Sample Response

HTTP Code: 200

{ "performanceMonitors":{ "total": 5, "statusIcon": "images/servicestatus5.gif", "down": 0, "monitors": [ { "YAXISTEXT": "%", "checkNumeric": "true", "data": [ { "instance": "-1", "value": 0} ], "Instance": "", "THRESHOLDENABLED": "false", "GRAPHID": "1159", "type": "multiple", "thresholdImg": "images/thresholdNonConfigured.gif", "suppressedMessage": "", "pollId": "522", "Protocol": "NCM", "DISPLAYNAME": "Config Change Count", "graphType": "node", "isSuppressed": "false", "policyName": "ChangesMonitor", "active": "true", "thresholdStatus": "Not Enabled", "isMultiple": "true", "sSave": "true", "pollingStatus": "0", "lastCollectedTime": "8 Oct 2025 10:47:43 AM IST", "groupName": "default", "DisplayColumn": "", "name": "ChangesMonitor", "interval": "60", "numericType": "1", "Id": "522"}, { "YAXISTEXT": "%", "checkNumeric": "true", "data": [ { "instance": "-1", "value": 47} ], "Instance": "", "THRESHOLDENABLED": "true", "GRAPHID": "10", "type": "node", "thresholdImg": "images/thresholdConOK.gif", "suppressedMessage": "", "pollId": "455", "Protocol": "SNMP", "DISPLAYNAME": "Memory Utilization", "graphType": "interface", "isSuppressed": "false", "policyName": "ProCurveMemoryUtilization", "active": "true", "thresholdStatus": "Normal", "isMultiple": "false", "sSave": "true", "pollingStatus": "0", "lastCollectedTime": "8 Oct 2025 11:17:12 AM IST", "groupName": "default", "DisplayColumn": "", "name": "ProCurveMemoryUtilization", "interval": "15", "numericType": "1", "Id": "455"}, { "YAXISTEXT": "%", "checkNumeric": "true", "data": [ { "instance": "-1", "value": 0} ], "Instance": "", "THRESHOLDENABLED": "true", "GRAPHID": "4766", "type": "node", "thresholdImg": "images/thresholdConOK.gif", "suppressedMessage": "", "pollId": "451", "Protocol": "SNMP", "DISPLAYNAME": "CPU Utilization", "graphType": "node", "isSuppressed": "false", "policyName": "hpSwitchCPUUtilization", "active": "true", "thresholdStatus": "Normal", "isMultiple": "false", "sSave": "true", "pollingStatus": "0", "lastCollectedTime": "8 Oct 2025 11:19:15 AM IST", "groupName": "default", "DisplayColumn": "", "name": "hpSwitchCPUUtilization", "interval": "5", "numericType": "1", "Id": "451"}, { "YAXISTEXT": "%", "checkNumeric": "true", "data": [ { "instance": "-1", "value": 0} ], "Instance": "", "THRESHOLDENABLED": "true", "GRAPHID": "373", "type": "node", "thresholdImg": "images/thresholdConOK.gif", "suppressedMessage": "", "pollId": "446", "Protocol": "SNMP", "DISPLAYNAME": "CPU Utilization", "graphType": "node", "isSuppressed": "false", "policyName": "ProCurveCPUUtilization", "active": "true", "thresholdStatus": "Normal", "isMultiple": "false", "sSave": "true", "pollingStatus": "0", "lastCollectedTime": "8 Oct 2025 11:17:12 AM IST", "groupName": "default", "DisplayColumn": "", "name": "ProCurveCPUUtilization", "interval": "15", "numericType": "1", "Id": "446"}, { "YAXISTEXT": "Hours", "checkNumeric": "true", "data": [ { "instance": "-1", "value": 6959} ], "Instance": "", "THRESHOLDENABLED": "false", "GRAPHID": "1166", "type": "node", "thresholdImg": "images/thresholdNonConfigured.gif", "suppressedMessage": "", "pollId": "443", "Protocol": "SNMP", "DISPLAYNAME": "SysUpTime", "graphType": "node", "isSuppressed": "false", "policyName": "SysUpTime", "active": "true", "thresholdStatus": "Not Enabled", "isMultiple": "false", "sSave": "true", "pollingStatus": "0", "lastCollectedTime": "8 Oct 2025 11:17:12 AM IST", "groupName": "default", "DisplayColumn": "", "name": "SysUpTime", "interval": "15", "numericType": "1", "Id": "443"} ]}, "deviceProtocol": "SNMP", "serverMonitors":{ "total": 0, "down": 0, "monitors": []}, "urlMonitors":{ "total": 0, "statusIcon": "images/servicestatus5.gif", "down": 0, "monitors": []}, "showPollingStatusColumn": true, "eventlogMonitors":{ "period": "300", "total": 0, "statusIcon": "images/servicestatus5.gif", "isActive": "false", "down": 0, "monitors": []}, "isDCMEnabled": true, "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=***************

Parameters

Param NameDescriptionData TypeAdditional InformationIs Mandatory
apiKeyAPI Key to access your OpManager server.  Yes
deviceNamedeviceName: Click here to learn how to get the Device NameString-Yes
categoryCategory of the device like Server, Desktop etcStringAllowed Characters: Any characters except the following special symbols — ^ @ * & ! + ` % ( ) {}=\ < >$ [ ] ' " : , ;Yes
typeType of the device like Windows 2019String-Yes

Sample Response

HTTP Code: 200

{ "performanceMonitors": [ { "monitorId": "1", "monitorName": "CPU Utilization", "category": "System Performance"}, { "monitorId": "2", "monitorName": "Memory Utilization", "category": "System Performance"} ]}

Error Response

View common error responses
Rate limit: 500 requests per minute. Exceeding this limit will block requests for 1 minute

getLastCollectedValues

Lists the last collected values of performance, application (AD, Exchange, and MSSQL) monitors, and script monitors for multiple devices.

HTTP Method

GET

API URL

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

Parameters

Param NameDescriptionData TypeAdditional InformationIs Mandatory
apiKeyAPI Key to access your OpManager server.  Yes
deviceMOIDListMOID is the value of the 'moid' property in the listDevices API response. For multiple MOIDs, use comma-separated values. It is recommended to pass up to 500 device MOIDs. Click here to learn how to get the MOIDnumbernumberWithCommaYes

Sample Response

HTTP Code: 200

{ "1802": [ { "NumericType": 1, "deviceName": "10.63.17.246", "ProtocolName": "WMI", "Description": "Monitors the Memory Utilization using WMI", "GraphName": "WMI-MemoryUtilization", "GraphTypeName": "multiple", "data": [ { "instance": "-1", "value": 32} ], "GraphId": 204, "PollId": 405, "OID": "Memory Utilization", "previousSeverity": 5, "YAxisText": "%", "lastCollectedTime": "23 Jan 2025 06:21:46 PM IST", "failureThreshold": 1, "PolicyName": "WMI-MemoryUtilization", "lastPolledCounterValue": 0, "DataType": "1", "failureCount": 0}, { "NumericType": 1, "deviceName": "10.63.17.246", "ProtocolName": "WMI", "Description": "Monitors the Disk Utilization using WMI", "GraphName": "WMI-DiskUtilization", "GraphTypeName": "multiple", "data": [ { "instance": "-1", "value": 93} ], "GraphId": 205, "PollId": 406, "OID": "Disk Utilization", "previousSeverity": 5, "YAxisText": "%", "lastCollectedTime": "23 Jan 2025 06:21:46 PM IST", "failureThreshold": 1, "PolicyName": "WMI-DiskUtilization", "lastPolledCounterValue": 0, "DataType": "1", "failureCount": 0}, { "NumericType": 1, "deviceName": "10.63.17.246", "ProtocolName": "WMI", "Description": "Monitoring the usage in each partition of the Device using WMI.", "GraphName": "WMI-PartitionDetails", "GraphTypeName": "multiplenode", "data": [ { "instance": "-1", "value": 93} ], "GraphId": 304, "PollId": 407, "OID": "Partition Details of the Device", "previousSeverity": 5, "YAxisText": "Percentage", "lastCollectedTime": "23 Jan 2025 06:21:46 PM IST", "failureThreshold": 1, "PolicyName": "WMI-PartitionDetails", "lastPolledCounterValue": 0, "DataType": "1", "failureCount": 0}, { "NumericType": 1, "deviceName": "10.63.17.246", "ProtocolName": "WMI", "Description": "The rate of IO Read and Write operations performed on the server", "GraphName": "WMIIOReadandWriteRate", "GraphTypeName": "node", "data": [ { "instance": "-1", "value": 11} ], "GraphId": 2233, "PollId": 408, "OID": "WMI IO Read and Write Rate", "previousSeverity": 5, "YAxisText": "Operations/Sec", "lastCollectedTime": "23 Jan 2025 06:21:46 PM IST", "failureThreshold": 1, "PolicyName": "WMIIOReadandWriteRate", "lastPolledCounterValue": 0, "DataType": "1", "failureCount": 0}, { "NumericType": 1, "deviceName": "10.63.17.246", "ProtocolName": "WMI", "Description": "Average time taken in milliseconds for a complete disk (read + write + transfer) operaton", "GraphName": "WMIAvgDiskLatency", "GraphTypeName": "node", "GraphId": 2227, "PollId": 409, "OID": "WMI Average Disk Latency", "previousSeverity": 5, "YAxisText": "MilliSeconds", "failureThreshold": 1, "PolicyName": "WMIAvgDiskLatency", "lastPolledCounterValue": 0, "DataType": "1", "failureCount": 0}, { "NumericType": 1, "deviceName": "10.63.17.246", "ProtocolName": "WMI", "Description": "Number of minutes the computer has been running after it was last started", "GraphName": "WMISystemUpTime", "GraphTypeName": "node", "data": [ { "instance": "-1", "value": 251982} ], "GraphId": 2245, "PollId": 410, "OID": "WMI System UpTime", "previousSeverity": 5, "YAxisText": "Minutes", "lastCollectedTime": "23 Jan 2025 06:21:53 PM IST", "failureThreshold": 1, "PolicyName": "WMISystemUpTime", "lastPolledCounterValue": 0, "DataType": "1", "failureCount": 0}, { "NumericType": 1, "deviceName": "10.63.17.246", "ProtocolName": "WMI", "Description": "Monitors the CPU Utilization using WMI", "GraphName": "WMI-CPUUtilization", "GraphTypeName": "multiple", "data": [ { "instance": "-1", "value": 2} ], "GraphId": 203, "PollId": 411, "OID": "CPU Utilization ProcessorInformation", "previousSeverity": 5, "YAxisText": "%", "lastCollectedTime": "23 Jan 2025 06:22:13 PM IST", "failureThreshold": 1, "PolicyName": "WMI-CPUUtilization", "lastPolledCounterValue": 0, "DataType": "1", "failureCount": 0} ], "1804": [ { "NumericType": 1, "deviceName": "server1.test.com", "ProtocolName": "WMI", "Description": "Monitors the Memory Utilization using WMI", "GraphName": "WMI-MemoryUtilization", "GraphTypeName": "multiple", "data": [ { "instance": "-1", "value": 81} ], "GraphId": 204, "PollId": 416, "OID": "Memory Utilization", "previousSeverity": 5, "YAxisText": "%", "lastCollectedTime": "23 Jan 2025 06:22:48 PM IST", "failureThreshold": 1, "PolicyName": "WMI-MemoryUtilization", "lastPolledCounterValue": 0, "DataType": "1", "failureCount": 0}, { "NumericType": 1, "deviceName": "server1.test.com", "ProtocolName": "WMI", "Description": "Monitoring the usage in each partition of the Device using WMI.", "GraphName": "WMI-PartitionDetails", "GraphTypeName": "multiplenode", "data": [ { "instance": "-1", "value": 92} ], "GraphId": 304, "PollId": 417, "OID": "Partition Details of the Device", "previousSeverity": 5, "YAxisText": "Percentage", "lastCollectedTime": "23 Jan 2025 06:22:48 PM IST", "failureThreshold": 1, "PolicyName": "WMI-PartitionDetails", "lastPolledCounterValue": 0, "DataType": "1", "failureCount": 0}, { "NumericType": 1, "deviceName": "server1.test.com", "ProtocolName": "WMI", "Description": "Monitoring the usage in each partition of the Device using WMI.", "GraphName": "WMI-PartitionDetails", "GraphTypeName": "multiplenode", "data": [ { "instance": "-1", "value": 22} ], "GraphId": 304, "PollId": 418, "OID": "Partition Details of the Device", "previousSeverity": 5, "YAxisText": "Percentage", "lastCollectedTime": "23 Jan 2025 06:22:48 PM IST", "failureThreshold": 1, "PolicyName": "WMI-PartitionDetails", "lastPolledCounterValue": 0, "DataType": "1", "failureCount": 0}, { "NumericType": 1, "deviceName": "server1.test.com", "ProtocolName": "WMI", "Description": "Monitoring the usage in each partition of the Device using WMI.", "GraphName": "WMI-PartitionDetails", "GraphTypeName": "multiplenode", "data": [ { "instance": "-1", "value": 87} ], "GraphId": 304, "PollId": 419, "OID": "Partition Details of the Device", "previousSeverity": 5, "YAxisText": "Percentage", "lastCollectedTime": "23 Jan 2025 06:22:48 PM IST", "failureThreshold": 1, "PolicyName": "WMI-PartitionDetails", "lastPolledCounterValue": 0, "DataType": "1", "failureCount": 0}, { "NumericType": 1, "deviceName": "server1.test.com", "ProtocolName": "WMI", "Description": "The rate of IO Read and Write operations performed on the server", "GraphName": "WMIIOReadandWriteRate", "GraphTypeName": "node", "data": [ { "instance": "-1", "value": 199974} ], "GraphId": 2233, "PollId": 420, "OID": "WMI IO Read and Write Rate", "previousSeverity": 5, "YAxisText": "Operations/Sec", "lastCollectedTime": "23 Jan 2025 06:22:49 PM IST", "failureThreshold": 1, "PolicyName": "WMIIOReadandWriteRate", "lastPolledCounterValue": 0, "DataType": "1", "failureCount": 0}, { "NumericType": 1, "deviceName": "server1.test.com", "ProtocolName": "WMI", "Description": "Average time taken in milliseconds for a complete disk (read + write + transfer) operaton", "GraphName": "WMIAvgDiskLatency", "GraphTypeName": "node", "GraphId": 2227, "PollId": 421, "OID": "WMI Average Disk Latency", "previousSeverity": 5, "YAxisText": "MilliSeconds", "failureThreshold": 1, "PolicyName": "WMIAvgDiskLatency", "lastPolledCounterValue": 0, "DataType": "1", "failureCount": 0}, { "NumericType": 1, "deviceName": "server1.test.com", "ProtocolName": "WMI", "Description": "Monitors the CPU Utilization using WMI", "GraphName": "WMI-CPUUtilization", "GraphTypeName": "multiple", "data": [ { "instance": "-1", "value": 6} ], "GraphId": 203, "PollId": 422, "OID": "CPU Utilization ProcessorInformation", "previousSeverity": 5, "YAxisText": "%", "lastCollectedTime": "23 Jan 2025 06:22:49 PM IST", "failureThreshold": 1, "PolicyName": "WMI-CPUUtilization", "lastPolledCounterValue": 0, "DataType": "1", "failureCount": 0}, { "NumericType": 1, "deviceName": "server1.test.com", "ProtocolName": "WMI", "Description": "Description", "GraphName": "Processor.PercentUserTime._Total", "GraphTypeName": "node", "GraphId": 5177, "PollId": 413, "OID": "Processor.PercentUserTime._Total", "previousSeverity": 5, "YAxisText": "Units", "failureThreshold": 1, "PolicyName": "Processor.PercentUserTime._Total", "lastPolledCounterValue": 0, "DataType": "1", "failureCount": 0}, { "NumericType": 1, "deviceName": "server1.test.com", "ProtocolName": "WMI", "Description": "Number of minutes the computer has been running after it was last started", "GraphName": "WMISystemUpTime", "GraphTypeName": "node", "data": [ { "instance": "-1", "value": 8505} ], "GraphId": 2245, "PollId": 414, "OID": "WMI System UpTime", "previousSeverity": 5, "YAxisText": "Minutes", "lastCollectedTime": "23 Jan 2025 06:22:49 PM IST", "failureThreshold": 1, "PolicyName": "WMISystemUpTime", "lastPolledCounterValue": 0, "DataType": "1", "failureCount": 0}, { "NumericType": 1, "deviceName": "server1.test.com", "ProtocolName": "WMI", "Description": "Monitors the Disk Utilization using WMI", "GraphName": "WMI-DiskUtilization", "GraphTypeName": "multiple", "data": [ { "instance": "-1", "value": 71} ], "GraphId": 205, "PollId": 415, "OID": "Disk Utilization", "previousSeverity": 5, "YAxisText": "%", "lastCollectedTime": "23 Jan 2025 06:22:48 PM IST", "failureThreshold": 1, "PolicyName": "WMI-DiskUtilization", "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

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

Parameters

Param NameDescriptionData TypeAdditional InformationIs Mandatory
apiKeyAPI Key to access your OpManager server.  Yes
name Click here to learn how to get the Device NameString-Yes
policyName Click here to learn how to get the policy Name.StringAllowed Characters: Any characters **except** asterisk (*), caret (^), less than (<), greater than (>), plus (+), comma (,), curly braces ({, })Yes
graphNameIf 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:StringAllowed Characters: Any characters **except** asterisk (*), caret (^), less than (<), greater than (>), plus (+), comma (,), curly braces ({, })No
pollIdPoll Id of the performance monitor.(We can use this pollId instead of graphName when its contains special characters)long-No
checkNumericType of monitor if it is Numeric Type it is should be true else falseBoolean Yes
instanceNameWhen the monitor is an MSSQL Application Monitor, pass this parameter with the MSSQL instance name. a href="https://www.manageengine.com/network-monitoring/help/rest-api-variables-faq.html#mssql-instance-name" target="_blank"> Click here to learn how to get the instance of the monitor.StringAllowed Characters: Unicode letters, numbers, hash (#), dollar ($), underscore (_), and ampersand (&)No
instanceWhen the monitor is an MSSQL Application Monitor, pass this parameter with the MSSQL instance name.StringAllowed Values: The input must contain one of the following — Url,Device,Packet_LossNo
oidoid of the monitorString-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 NameDescriptionData TypeAdditional InformationIs Mandatory
apiKeyAPI Key to access your OpManager server.String-Yes
name Click here to learn how to get the Device NameString-Yes
selectedMonitorsGraphID of the performance monitor(s) (multiple values separated by commas). Click here to learn how to get the graph id of the performance monitors.String-Yes
processExistingPartitionMonitorsThis is required for processing the existing partition monitors. true(Existing partition monitors will be Process) false(Existing partition monitors will not be Process)Boolean-No
selectedPartitionsThis is required for adding the required PartitionsJSONObjectselectedPartitionsJSON ::{"GraphID":["Partition1","Partition2"]} Ex:-{"297":["C:","D:"],"298":["D:","E:"]}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 NameDescriptionData TypeAdditional InformationIs Mandatory
apiKeyAPI Key to access your OpManager server.String-Yes
name Click here to learn how to get the Device NameString-Yes
pollIdUnique association ID of the performance monitor. Click here to learn how to get the poll id of a monitorNumbernumberWithCommaYes

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

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

Parameters

Param NameDescriptionData TypeAdditional InformationIs Mandatory
apiKeyAPI Key to access your OpManager server.  Yes
name Click here to learn how to get the Device NameString-Yes
policyNameThe policy name for the performance monitor can be obtained from the graphName field in the response of the listPerformanceMonitors API. Click here to learn how to get the policy NameStringAccepts any character except asterisk (*), caret (^), less-than (<), greater-than (>), plus (+), comma (,), curly braces ({}), with at least one character required.Yes
graphNameIf 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:.StringAccepts any character except asterisk (*), caret (^), less-than (<), greater-than (>), plus (+), comma (,), curly braces ({}), with at least one character required.No
pollIdUnique association ID of the performance monitor. You can pass either the pollId or the graphName to uniquely identify the monitor. Prefer using the ID when the graphName contains non-alphanumeric characters. Click here to learn how to get the poll id of a monitor.long-No
instanceNameWhen the monitor is an MSSQL Application Monitor, pass this parameter with the MSSQL instance name. Click here to learn how to get the instance of the MSSQL monitor.StringAllowed Characters: Unicode letters, numbers, hash (#), dollar ($), underscore (_), and ampersand (&)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

Fetches the list of process monitors that have been associated to a device

HTTP Method

GET

API URL

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

Parameters

Param NameDescriptionData TypeAdditional InformationIs Mandatory
apiKeyAPI Key to access your OpManager server.String-Yes
deviceName Click here to learn how to get the Device NameString-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 NameDescriptionData TypeAdditional InformationIs Mandatory
apiKeyAPI Key to access your OpManager server.String-Yes
deviceName Click here to learn how to get the Device NameString-Yes
protocolProtocol of the device to associate for monitoringString of values WMI, CLI or SNMPAllowed Values: The input must contain one of the following — WMI, CLI,SNMPYes
processIdID of the processes that need to be associated (multiple values separated by commas)NumbernumberWithCommaYes

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

Fetches the list of service monitors that have been associated to a device

HTTP Method

GET

API URL

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

Parameters

Param NameDescriptionData TypeAdditional InformationIs Mandatory
apiKeyAPI Key to access your OpManager server.String-Yes
name Click here to learn how to get the Device NameString-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=devicename&serviceName=DNS,FTP,Echo

Parameters

Param NameDescriptionData TypeAdditional InformationIs Mandatory
apiKeyAPI Key to access your OpManager server.String-Yes
deviceName Click here to learn how to get the Device NameStringstringWithCommaYes
serviceNameName of the service(s) (multiple values separated by commas).StringstringWithCommaYes

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

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=***************&deviceName=devicename

Parameters

Param NameDescriptionData TypeAdditional InformationIs Mandatory
apiKeyAPI Key to access your OpManager server.String-Yes
deviceName Click here to learn how to get the Device NameString-Yes

Sample Response

HTTP Code: 200

{ "windowsServiceMonitors": [ { "serviceName": "Spooler", "displayName": "Print Spooler", "status": "Running", "startupType": "Automatic"} ]}

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 NameDescriptionData TypeAdditional InformationIs Mandatory
apiKeyAPI 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 NameDescriptionData TypeAdditional InformationIs Mandatory
apiKeyAPI 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

Lists all script monitors configured in the system

HTTP Method

GET

API URL

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

Parameters

Param NameDescriptionData TypeAdditional InformationIs Mandatory
apiKeyAPI 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

Thank you for your feedback!

Was this content helpful?

We are sorry. Help us improve this page.

How can we improve this page?
Do you need assistance with this topic?
By clicking "Submit", you agree to processing of personal data according to the Privacy Policy.

Thank you for your feedback!

Was this content helpful?

We are sorry. Help us improve this page.

How can we improve this page?
Do you need assistance with this topic?
By clicking "Submit", you agree to processing of personal data according to the Privacy Policy.
 
Related Products