listAlarms
Method: GET
Description: Lists all the alarms generated in OpManager.
Sample URL: https://localhost:8060/api/json/alarm/listAlarms?apiKey=***************
OpManager offers REST APIs for adding and fetching data from OpManager. Using these APIs, you can integrate OpManager with 3rd party IT management/service desk software.
The APIs work with an API key. The API key is unique for each OpManager account and has to passed as a parameter in every API request made. First, generate an API key.
To generate an API key, go to Settings > Basic Settings > REST API in OpManager web client and click on Regenerate Key.
Method: GET
Description: Lists all the alarms generated in OpManager.
Sample URL: https://localhost:8060/api/json/alarm/listAlarms?apiKey=***************
Method: GET
Description: To list alarm properties of the particular alarm
Sample URL: https://localhost:8060/api/json/alarm/alarmProperties?apiKey=***************&entity=entity1_Poll
Method: POST
Description: This API is used to add notes to an alarm
Sample URL: https://localhost:8060/api/json/alarm/addNotes?apiKey=***************
Method: POST
Description: This API is used to acknowledge an alarm
Sample URL: https://localhost:8060/api/json/alarm/acknowledgeAlarm?apiKey=***************
Method: POST
Description: This API is used to unacknowledge an alarm
Sample URL: https://localhost:8060/api/json/alarm/unAcknowledgeAlarm?apiKey=***************
Method: POST
Description: This API is used to clear an Alarm.
Sample URL: https://localhost:8060/api/json/alarm/clearAlarm?apiKey=***************
Method: POST
Description: This API is to delete an alarm
Sample URL: https://localhost:8060/api/json/alarm/deleteAlarm?apiKey=***************
Method: GET
Description: This API is to get alarms based on devices
Sample URL: https://localhost:8060/api/json/alarm/getTopDevicesByAlarms?apiKey=***************
Method: GET
Description: This API is to get notes of the alarms
Sample URL: https://localhost:8060/api/json/alarm/getAnnotation?apiKey=***************
Method: GET
Description: ICMP/Ping response for the given device.
Sample URL: https://localhost:8060/api/json/device/getPingResponse?apiKey=***************&deviceName=192.168.49.4
Method: GET
Description: Trace route command response for the given device
Sample URL: https://localhost:8060/api/json/device/getTraceResponse?apiKey=***************&deviceName=192.168.49.4
Method: GET
Description: Lists the devices that are currently in down state and having device status as 'critical'
Sample URL: https://localhost:8060/api/json/discovery/getDownDevices?apiKey=******************
Method: GET
Description: Fetches the Availability graphs for the given device or interface.
Sample URL: https://localhost:8060/api/json/device/getAvailabilityGraphData?apiKey=******************&isFluidic=true&name=opmserver.mydomain.com
Method: GET
Description: Provides the list of downtime schedules created in OpManager.
Sample URL: https://localhost:8060/api/json/admin/listDownTimeSchedules?apiKey=****************
Method: POST
Description: Manage or Unmanage the devices,interfaces or URL monitors that are currently added in OpManager.
Sample URL: https://localhost:8060/api/json/device/setManaged?manage=true&apiKey=***************
Method: GET
Description: Lists all the business views created in OpManager.
Sample URL: https://localhost:8060/api/json/businessview/getBusinessView?apiKey=***************
Method: GET
Description: Lists all the devices available in the given business view
Sample URL: https://localhost:8060/api/json/businessview/getBusinessDetailsView?apiKey=***************&bvName=ProductionSite_bv
Method: GET
Description: This API is used to fetch the data to be loaded for a given widget id.
Sample URL: https://localhost:8060/api/json/dashboard/getWidgetData?apiKey=***************&widgetID=495
Method: GET
Description: This API is used to list the widgets to be loaded for a given dashboard.
Sample URL: https://localhost:8060/api/json/dashboard/getWidgetsList?apiKey=***************&dashboardName=dashboardname
Method: GET
Description: Lists all the devices added in OpManager.
Sample URL: https://localhost:8060/api/json/device/listDevices?apiKey=****************&
Method: GET
Description: Provides custom field values associated to the given device such as Building, Cabinet, Serial number, etc.
Sample URL: https://localhost:8060/api/json/device/getDeviceNotes?apiKey=***************&name=192.168.49.1
Method: GET
Description: Provides categorywise details of devices such as device name, device displayname, status, IP Address, Device type and the associated performance monitor values.
Sample URL: https://localhost:8060/api/json/discovery/getInfrastructureDetailsView?apiKey=**************&categoryName=Server
Method: GET
Description: Provides the device details as in the Device snapshot page
Sample URL: https://localhost:8060/api/json/device/getDeviceSummary?apiKey=**************&name=opmserver.testdomain.com
Method: GET
Description: Lists all the entities of selected virtual type.
Sample URL: https://localhost:8060/api/json/device/listVirtualDevices?apiKey=***************&virtualDeviceType=VM
Method: GET
Description: Lists the basic details and availability of the device
Sample URL: https://localhost:8060/api/json/v2/device/getDeviceCompleteDetails?apiKey=***************&name=devicename
Method: POST
Description: Allows you to add individual devices to OpManager for monitoring.
Sample URL: https://localhost:8060/api/json/discovery/addDevice?apiKey=***************&name=opmserver.mydomain.com
Method: GET
Description: This API is to list all the probes
Sample URL: https://localhost:8060/api/json/alarm/listProbes?apiKey=***************
Method: GET
Description: Lists event history.
Sample URL: https://localhost:8060/api/json/events/listEvents?apiKey=***************&deviceName=opmrouter
Method: GET
Description: Lists all the groups available in OpManager. Also provides basic group information such as members count and group health.
Sample URL: https://localhost:8060/api/json/admin/listAllLogicalGroups?apiKey=***************
Method: GET
Description: Provides details (such as members count, group status, etc.) of the given group.
Sample URL: https://localhost:8060/api/json/admin/getLogicalGroupInfo?apiKey=***************&groupName=NorthBayRegion-4201&period=3&snapType=LogicalDeviceGroup
Method: GET
Description: Fetches the alarms generated from the members (devices/interfaces) of the given group.
Sample URL: https://localhost:8060/api/json/admin/getLogicalGroupAlerts?apiKey=***************&groupName=bvgcty-4201
Method: GET
Description: Provides information on the members available in the given group.
Sample URL: https://localhost:8060/api/json/admin/listLogicalGroupMembers?apiKey=***************&groupName=NorthBayRegion-4201
Method: POST
Description: Allows you to add device(s) to the specified Group.
Sample URL: https://localhost:8060/api/json/device/addToGroup?apiKey=***************&groupType=device&selectedMembers=10.1.1.20,opmserver
Method: GET
Description: Lists all the interfaces monitored in OpManager
Sample URL: https://localhost:8060/api/json/device/listInterfaces?apiKey=***************&isFluidic=true&rows=100&page=1&sortByColumn=statusNum&sortByType=desc
Method: GET
Description: Provides basic details of the interface such as ifIndex, ifName, ifDesc, ifAlias, parent device, Rx/Tx Traffic, etc.
Sample URL: https://localhost:8060/api/json/device/getInterfaceSummary?apiKey=***************&interfaceName=IF-172.24.146.225-4429
Method: GET
Description: Provides a consolidated availability and performance monitoring health report data for the given interface.
Sample URL: https://localhost:8060/api/json/v2/device/getIntfAtAGlanceReportDetails?apiKey=***************&InterfaceName=IF-192.168.49.4-3820&period=Today
Method: GET
Description: Provides data for consolidated Bandwidth report (Rx/Tx Traffic) for the given interface.
Sample URL: https://localhost:8060/api/json/v2/device/getIntfBWOutageReportDetails?apiKey=***************&interfaceName=IF-192.168.49.4-3836&period=Today
Method: GET
Description: Provides the list of interfaces monitored in a device.
Sample URL: https://localhost:8060/api/json/device/getInterfaces?apiKey=***************&name=opmserver.testdomain.com
Method: GET
Description: Fetches the custom field values associated to the given interface.
Sample URL: https://opmserver:8060/api/json/device/getInterfaceNotes?apiKey=************&interfaceName=IF-opmserver.testdomain.com-4505
Method: GET
Description: Fetches the collected data (such as traffic, errors & discards, etc.) for the given interface.
Sample URL: https://localhost:8060/api/json/device/getInterfaceGraphs?apiKey=***************&interfaceName=IF-192.168.49.106-329&graphName=rxutilization
Method: GET
Description: Lists all the monitors associated to the device
Sample URL: https://localhost:8060/api/json/device/getDeviceAssociatedMonitors?apiKey=***************&name=devicename
Method: GET
Description: Lists all the available performance monitors for a particular device (based on the device's category and type)
Sample URL: https://localhost:8060/api/json/device/getPerformanceMonitors?apiKey=***************&deviceName=devicename&category=Desktop&type=Windows 2008 R2
Method: GET
Description: Lists the details of an associated performance monitor from a particular device
Sample URL: https://localhost:8060/api/json/device/getPerformanceMonitorDetails?apiKey=***************&name=devicename&policyName=WMI-CPUUtilization&graphName=WMI-CPUUtilization&checkNumeric=true
Method: POST
Description: Adds a new performance monitor (or multiple performance monitors) to the device
Sample URL: https://localhost:8060/api/json/device/addPerformanceMonitors?apiKey=***************&name=devicename&selectedMonitors=1166,3337,304,204,205,203,3327
Method: POST
Description: Deletes performance monitor(s) from the device
Sample URL: https://localhost:8060/api/json/device/deletePerformanceMonitors?apiKey=***************&name=devicename&pollId=332,213
Method: POST
Description: Tests a performance monitor in a particular device
Sample URL: https://localhost:8060/api/json/device/TestMonitor?apiKey=***************&name=devicename&policyName=WMI-MemoryUtilization&graphName=WMI-MemoryUtilization
Method: GET
Description: Fetches the list of process monitors that have been associated to a device
Sample URL: https://localhost:8060/api/json/device/getAssociatedProcessMonitors?apiKey=***************&deviceName=devicename
Method: POST
Description: Associates process monitor(s) to a device
Sample URL: https://localhost:8060/api/json/device/associateProcessMonitor?apiKey=***************&deviceName=devicename&processId=408,8,68&protocol=WMI
Method: GET
Description: Fetches the list of service monitors that have been associated to a device
Sample URL: https://localhost:8060/api/json/device/getAssociatedServiceMonitors?apiKey=***************&name=devicename
Method: POST
Description: Associates service monitor(s) to a device
Sample URL: https://localhost:8060/api/json/admin/associateServiceMonitor?apiKey=***************&deviceName=devicename&serviceName=DNS,FTP,Echo
Method: GET
Description: Lists the associated Windows Service Monitors for a device
Sample URL: https://localhost:8060/api/json/device/getDeviceAssociatedWindowsServiceMonitors?apiKey=***************&name=devicename
Method: GET
Description: Lists all the global URL monitors available in OpManager
Sample URL: https://localhost:8060/api/json/admin/listURLMonitors?apiKey=***************
Method: GET
Description: Lists all the script templates available in OpManager
Sample URL: https://localhost:8060/api/json/admin/listScriptMonitors?apiKey=***************
Method: GET
Description: This API is used to list all the Notification Profiles created in OpManager.
Sample URL: https://localhost:8060/api/json/admin/listNotificationProfiles?apiKey=***************&isGlobal=true&profileFilter=All&deviceName=devicename
Method: POST
Description: This API is used to associate notification profiles to devices.
Sample URL: https://localhost:8060/api/json/admin/associateNotificationProfiles?apiKey=***************&deviceName=devicename&profiles=501
Method: GET
Description: This API is to list all the reports
Sample URL: https://localhost:8060/api/json/reports/getReportsList?apiKey=***************&isFavouriteNeeded=true&hideintegratedReports=true&hideHardwareReport=true
Method: GET
Description: The API to get the required report data.
Sample URL: https://localhost:8060/api/json/reports/getReportsData?apiKey=***************&reportID=84&isExcludeDays=true&excludedDays=Monday,Tuesday&category=Desktop&bview=All&time=Last_Month&timeWindow=8-20&isBusinessHour=false&showType=0&top=1000&viewAs=json
Method: GET
Description: This api can be used to list all the created Business Hour Rules.
Sample URL: https://localhost:8060//api/json/admin/listBusinessRules?apiKey=***************
Method: POST
Description: This api is used to configure business hour rule from Monday to Sunday.
Sample URL: https://localhost:8060/api/json/admin/addBusinessRules?apiKey=***************&businessRuleName=Rule1&description=Indian standard time shift 1.&timeSettings={"monday":"1-5","tuesday":"3-6","wednesday":"3-5","thursday":"2-5","friday":"5-13"}
Method: POST
Description: This api is to delete business hour rule created already.
Sample URL: https://localhost:8060//api/json/admin/deleteBusinessRules?apiKey=***************&businessRuleId=1
Method: GET
Description: This api is to view the business hour rule created already.
Sample URL: https://localhost:8060//api/json/admin/viewBusinessRules?apiKey=***************&businessRuleId=1
Method: POST
Description: This api is used to update the configured business hour rule From Monday to Sunday.
Sample URL: https://localhost:8060/api/json/admin/updateBusinessRules?apiKey=***************&businessRuleName=Rule1&description=Indian standard time shift 1.&timeSettings={"monday":"1-5","tuesday":"3-6","wednesday":"3-5","thursday":"2-5","friday":"5-13"}&businessRuleId=1
Method: POST
Description: The api to fetch data of report builder reports.
Sample URL: https://localhost:8060//api/json/admin/getReportData?apiKey=***************&deviceList=moname1,moname2&monitorList=DevicesAvailability,ResponseTime,WMI-CPUUtilization,MSSQLDataFilesSizeKB&timePeriod=Last_Month&view=table&timeWindow=0-24&startDate=2020-11-09&endDate=2020-11-18-18
Method: GET
Description: This api can be used to fetch all the created Advanced Reports.
Sample URL: https://localhost:8060//api/json/admin/listAllAdvancedReports?apiKey=***************
Method: POST
Description: Lists all the available device categories
Sample URL: https://localhost:8060/api/json/device/getCategoryList?apiKey=***************
Method: GET
Description: Lists all the Subnets monitored in OpManager
Sample URL: https://localhost:8060/api/json/device/listSubnets?apiKey=***************
Method: GET
Description: Lists Access Points, Client Count and Network Usage for each SSID in Wireless LAN Controller
Sample URL: https://localhost:8060/api/json/wireless/getWirelessNetworkDetails?apiKey=***************&deviceName=CiscoWirelessController
Method: GET
Description: Lists all Access Points in the WLC Device.
Sample URL: https://localhost:8060/api/json/wireless/getWirelessAPList?apiKey=***************&deviceName=CiscoWirelessController
Method: GET
Description: Lists all the SSID Clients associated with the given WLC device.
Sample URL: https://localhost:8060/api/json/wireless/getSSIDClientList?apiKey=***************&deviceName=CiscoWirelessController
Method: GET
Description: Fetches the client devices connected to the given SSID of WLC device.
Sample URL: https://localhost:8060/api/json/wireless/getClientDetails?apiKey=***************&deviceName=CiscoWirelessController&ssidName=WorkstationNetwork