OpManager REST API

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.

How OpManager REST APIs work?

The APIs work with an API key. The API key is unique for each OpManager account and is mandatory for all API requests.

Generate API Key

To generate an API key, go to Settings > Basic Settings > REST API in OpManager web client and click on Regenerate Key.

Alarms

listAlarms

Method: GET

Description: Lists all the alarms generated in OpManager.

Sample URL: http://localhost:8060/api/json/alarm/listAlarms?apiKey=********&deviceName=test1.zoho.com&severity=1&category=Device_Category&entity=entity_123&alertType=ActiveAlarms&fromTime=2022-05-02 08:00:00&toTime=2022-06-02 18:30:00

Parameter name

Description

apiKey*

API Key to access your OpManager server.

deviceName

Device Name of the alarm. The device name can be taken from the URL of the device snapshot page.

severity

Severity of the alarm. The severity could range anywhere from 1 to 5. 1 = Critical, 2 = Trouble, 3 = Attention, 4 = Service Down, 5 = Clear.

category

Device category of the alarm

alertType

alertType of the alarm. The alert type can be any of the following: ActiveAlarms, EventLogAlarms, SyslogAlarms, TrapAlarms, NCMAlarms, NFAAlarms, WebAlarms, FWAAlarms, StorageAlarms.

fromTime

Start time for the custom time period range. It could be of the format yyyy-mm-dd or yyyy-mm-dd hh:mm:ss. If no time is specified (i.e, yyyy-mm-dd format), the default time will be set to 12 A.M(start of the day).

toTime

End time for the custom time period range. It could be of the format yyyy-mm-dd or yyyy-mm-dd hh:mm:ss. If no time is specified (i.e, yyyy-mm-dd format), the default time will be set to 12 A.M(start of the day).

Note: Both the fromTime and toTime parameters should be used together to set a custom time period.

alarmProperties

Method: GET

Description: To list alarm properties of the particular alarm

Sample URL: https://localhost:8060/api/json/alarm/alarmProperties?apiKey=***************&entity=entity1_Poll

Parameter name

Description

apiKey*

API Key to access your OpManager server.

entity

Entity of the alarm

alarmSpecific

Boolean to mention whether it is alarmSpecific.

deviceID

MOID of the alarm

addNotes

Method: POST

Description: This API is used to add notes to an alarm

Sample URL: https://localhost:8060/api/json/alarm/addNotes?apiKey=***************

Parameter name

Description

apiKey*

API Key to access your OpManager server.

entity*

Entity of the alarm

notes

Notes description to be added

type

To mention whether single or multiple alarms are selected

acknowledgeAlarm

Method: POST

Description: This API is used to acknowledge an alarm

Sample URL: https://localhost:8060/api/json/alarm/acknowledgeAlarm?apiKey=***************

Parameter name

Description

apiKey*

API Key to access your OpManager server.

entity*

Entity of the alarm

type

To mention whether single or multiple alarms are selected

unAcknowledgeAlarm

Method: POST

Description: This API is used to unacknowledge an alarm

Sample URL: http://localhost:8060/api/json/alarm/listAlarms?apiKey=********

Parameter name

Description

apiKey*

API Key to access your OpManager server.

entity*

Entity of the alarm

type

To mention whether single or multiple alarms are selected

clearAlarm

Method: POST

Description: This API is used to clear an Alarm.

Sample URL: https://localhost:8060/api/json/alarm/clearAlarm?apiKey=***************&entity=coldStart_trap

Parameter name

Description

apiKey*

API Key to access your OpManager server.

entity*

Entity of the alarm as seen in the url of the alarm page of a specific alarm, eg: https://localhost:8060/apiclient/ember/index.jsp#/Alarms/Alarm/Details/deviceDown_121212, here deviceDown_121212 is the entity of that alarm

type

To mention whether single alarm or multiple alarms are selected

deleteAlarm

Method: POST

Description: This API is to delete an alarm

Sample URL: https://localhost:8060/api/json/alarm/deleteAlarm?apiKey=***************&entity=coldStart_trap

Parameter name

Description

apiKey*

API Key to access your OpManager server.

entity*

Entity of the alarm as seen in the url of the alarm page of a specific alarm, eg: https://localhost:8060/apiclient/ember/index.jsp#/Alarms/Alarm/Details/deviceDown_121212, here deviceDown_121212 is the entity of that alarm

type

To mention whether single or multiple alarm is selected

getTopDevicesByAlarms

Method: GET

Description: This API is to get alarms based on devices

Sample URL: https://localhost:8060/api/json/alarm/getTopDevicesByAlarms?apiKey=***************

Parameter name

Description

apiKey*

API Key to access your OpManager server.

eventType*

Event type of the alarm

getAnnotation

Method: GET

Description: This API is to get notes of the alarms

Sample URL: https://localhost:8060/api/json/alarm/getAnnotation?apiKey=***************

Parameter name

Description

apiKey*

API Key to access your OpManager server.

entity*

Entity of the alarm

Availability

getPingResponse

Method: POST

Description: ICMP/Ping response for the given device.

Sample URL: https://localhost:8060/api/json/device/getPingResponse?apiKey=***************&deviceName=192.168.49.4

Parameter name

Description

apiKey*

API Key to access your OpManager server.

deviceName*

Name of the device - Managed Entity name as seen in the URL of device snapshot page OR 'deviceName' property value in the listDevices API response.

getTraceResponse

Method: POST

Description: Trace route command response for the given device

Sample URL: https://localhost:8060/api/json/device/getTraceResponse?apiKey=***************&deviceName=192.168.49.4

Parameter name

Description

apiKey*

API Key to access your OpManager server.

deviceName*

Name of the device - Managed Entity name as seen in the URL of device snapshot page OR 'deviceName' property value in the listDevices API response.

getDownDevices

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

Parameter name

Description

apiKey*

API Key to access your OpManager server.

getAvailabilityGraphData

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

Parameter name

Description

apiKey*

API Key to access your OpManager server.

name*

Name of the device or interface - Managed Entity name as seen in the URL of device/interface snapshot page OR 'deviceName' property value of listDevices API or 'interfaceName' property value in the listInterfaces API response [Example: opmserver.mydomain.com or IF-10.10.24.223-115]

instance

Set instance=Interface if the Availability graph is requested for the interface. Mandatory field if the interface data is being fetched. This API can also be used to fetch availability of other monitors. [Example: Interface|URL|winService|service|process]

isFluidic*

Set value as TRUE by default (for internal purpose)

listDownTimeSchedules

Method: GET

Description: Provides the list of downtime schedules created in OpManager.

Sample URL: https://localhost:8060/api/json/admin/listDownTimeSchedules?apiKey=****************

Parameter name

Description

apiKey*

API Key to access your OpManager server.

setManaged

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

Parameter name

Description

apiKey*

API Key to access your OpManager server.

manage*

Enables monitoring of devices or interfaces if manage=true, disables monitoring if manage=false

name*

Name of the device or interface. (Managed Entity name as seen in the URL of device/interface snapshot page OR 'deviceName' property value in the listDevices API response)

type

Set type as 'INTERFACE' if the managed entity is an interface. Set type as 'URL' if the managed entity is an Url monitor.

isInterface

This parameter will take effect only when the value 'INTERFACE' is supplied to type param. Set the value for this param as 'true' if the managed entity is an interface. By default, the entity will be assumed as device, hence it is not required to pass this parameter for managing device.

Business views

getBusinessView

Method: GET

Description: Lists all the business views created in OpManager.

Sample URL: https://localhost:8060/api/json/businessview/getBusinessView?apiKey=***************

Parameter name

Description

apiKey*

API Key to access your OpManager server.

getBusinessDetailsView

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

Parameter name

Description

apiKey*

API Key to access your OpManager server.

bvName*

Name of the Business View (as shown in the URL of Business View page).

Dashboard

getWidgetData

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

Parameter name

Description

apiKey*

API Key to access your OpManager server.

widgetID*

The widget ID for which data is to be fetched.

widgetName

The name of the widget.

widgetType

The widget type.

getWidgetsList

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

Parameter name

Description

apiKey*

API Key to access your OpManager server.

dashboardName*

Name of the dashboard.

Devices

listDevices

Method: GET

Description: Lists all the devices added in OpManager.

Sample URL: https://localhost:8060/api/json/device/listDevices?apiKey=****************&

Parameter name

Description

apiKey*

API Key to access your OpManager server.

isFluidic

Set value as 'true' by default.(for internal purpose)

type

Fetches the list of devices that fall under the given Device Type. [Example: type=Cisco2081]

category

Fetches the list of devices that fall under the given device category [Example: Server, Switch, etc.]

app

Fetches the list of devices that have the given App in it and monitored in OpManager [Example: MSSQL, Exchange, Domain Controller]

bvName

Fetches the list of devices that are under the given Business View map name

vendor

Fetches the list of devices that have the given vendor name.

protocol

severity

Filter devices by severity [Example: 1 (Critical), 2 (Trouble), 3 (Attention), 4 (service down), 5 (Clear), 7 (Unmanaged)]

selectedVTypes

groupName

Filter devices by Group name

customFields

To fetch custom field values associated to the device. Set as 'true' if you are using v2 API applicable in OpManager version above 12.x. [Example: /api/json/v2/device/listDevices]

getInterfaces

To fetch devices with associated interfaces. Boolean value: TRUE/FALSE

page

To fetch devices in batches. This should be combinedly used with 'rows' parameter. [Example: page=1, rows=200, page=2, rows=200]

rows

To fetch devices in batches. This should be combinedly used with 'page' parameter [Example: page=1, rows=200, page=2, rows=200]

sortByType

Defining sort type to be ascending or descending [Example, sortByType=asc Or sortByType=desc]

sortByColumn

Sorting device list by columns [Example: displayName, interfaceCount, ipaddress, type, etc.]

getDeviceNotes

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

Parameter name

Description

apiKey*

API Key to access your OpManager server.

name*

Name of the device - Managed Entity name as seen in the URL of the device snapshot page OR 'deviceName' property value in the listDevices API response.

getInfrastructureDetailsView

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

Parameter name

Description

apiKey*

API Key to access your OpManager server.

categoryName*

Name of the device category. [Example: Server, Desktop, etc]

getDeviceSummary

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

Parameter name

Description

apiKey*

API Key to access your OpManager server.

name*

Name of the device - Managed Entity name as seen in the URL of device snapshot page OR 'deviceName' property value in the listDevices API response.

isFluidic

Set value as TRUE by default. (for internal purpose)

snapType

Type of the device snapshot. If the device is monitored only in OpManager, set value as 'MonitoringDevice'. If Flow monitoring is enabled for this device, set value as 'FlowDevice'

RouterID

Router ID of the device if the snapType is set as 'FlowDevice'.

Virtual Devices

listVirtualDevices

Method: GET

Description: Lists all the entities of selected virtual type.

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

Parameter name

Description

apiKey*

API Key to access your OpManager server.

virtualDeviceType*

Type of virtual entity which you want to list. (Allowed values: VHOST, VDATASTORE, VM, VCENTER, HyperV-Host, HyperV-VM, HyperV-Disk, Xen-Host, Xen-VM, Xen-SR, Xen-Pool, Nutanix-Cluster, Nutanix-Host, Nutanix-VM)

getDeviceCompleteDetails

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

Parameter name

Description

apiKey*

API Key to access your OpManager server.

name*

Name of the device

Discovery

addDevice

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

Parameter name

Description

apiKey*

API Key to access your OpManager server.

deviceName*

Hostname, FQDN name or IP Address of the device

credentialName

Name of the credential used to access the device to fetch device information.

Enterprise

listProbes

Method: GET

Description: This API is to list all the probes

Sample URL: https://localhost:8060/api/json/admin/listProbes?apiKey=***************

Parameter name

Description

apiKey*

API Key to access your OpManager server.

Events

listEvents

Method: GET

Description: Lists event history.

Sample URL: https://localhost:8060/api/json/events/listEvents?apiKey=***************&deviceName=opmrouter

Parameter name

Description

apiKey*

API Key to access your OpManager server.

deviceName

Device name for which the events to be listed

entity

Entity of the event

period

Time period for which events should be listed

severity

Severity of the alarm

category

Device category of the alarm

eventType

EventType of the alarm

Groups

listAllLogicalGroups

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

Parameter name

Description

apiKey*

API Key to access your OpManager server.

getLogicalGroupInfo

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

Parameter name

Description

apiKey*

API Key to access your OpManager server.

groupName*

Name of the group with MOID appended in the suffix. such as -

period

Time for which the availability data is to be fetched.[Example: twelvehours(16),Today(6),twfourhours(3),Yesterday(7),thisweek(8),Last_7_Days(4),lastweek(9),thismonth(10),Last_30_Days(5),Last_Month(11),custom(23)]

snapType

Group Snapshot type. [Example: LogicalGroup|LogicalIntfGroup|LogicalDeviceGroup]

getLogicalGroupAlerts

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

Parameter name

Description

apiKey*

API Key to access your OpManager server.

groupName

Name of the group

listLogicalGroupMembers

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

Parameter name

Description

apiKey*

API Key to access your OpManager server.

groupName

Name of the Device/Interface Group having suffix as '- '. [Example: - ]

addToGroup

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

Parameter name

Description

apiKey*

API Key to access your OpManager server.

groupName*

Name of the Device/Interface Group with MOID in the suffix. [Example: - ]

groupType*

Type of the group [Example: device|interface]

selectedMembers*

Device name(s) supplied as a comma-separated string. Device name is a Managed entity name as seen in the device snapshot page URL OR in 'deviceName' property of the listDevices API response

Interfaces

listInterfaces

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

Parameter name

Description

apiKey*

API Key to access your OpManager server.

isFluidic

Set value as 'true' by default (for internal purpose)

rows

To fetch interface list in batches. This should be combinedly used with 'page' parameter [Example: page=1, rows=200, page=2, rows=200]

page

To fetch interface list in batches. This should be combinedly used with 'rows' parameter [Example: page=1, rows=200, page=2, rows=200]

sortByColumn

Sorting interfaces list with columns [Example: inSpeed, displayName, ipaddress, outSpeed, statusNum, severity - 1 (Critical), 2 (Trouble), 3 (Attention), 4 (service down), 5 (Clear), 7 (Unmanaged)]

sortByType

Defining ascending or descending sort of interfaces list [Example, sortByType=asc Or sortByType=desc]

severity

Filter interfaces with severity. [Example: 1 (Critical), 2 (Trouble), 3 (Attention), 4 (service down), 5 (Clear), 7 (Unmanaged)]

type

Filter interface with interface type. [Example: Ethernet,Software Loopback, etc]

intfProps

To fetch additional interface properties such as ifName (Interface ifName), moid (internal managed object identifier used for interface/device), physAddress

getInterfaceSummary

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

Parameter name

Description

apiKey*

API Key to access your OpManager server.

interfaceName*

ManagedObject name of the interface as seen in the URL of interface snapshot page.

getIntfAtAGlanceReportDetails

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

Parameter name

Description

apiKey*

API Key to access your OpManager server.

InterfaceName*

Name of the interface - Managed Entity name as seen in the URL of interface snapshot page OR 'interfaceName' property value in the listInterfaces API response.

period*

Period for which the interface data is required. [Example: twelvehours,Today,twfourhours,Yesterday,thisweek,Last_7_Days,lastweek,thismonth,Last_30_Days,Last_Month,custom]

startDate

From Date. This parameter is applicable only if 'custom' time is opted in period param value

endDate

To Date. This parameter is applicable only if 'custom' time is opted in period param value

getIntfBWOutageReportDetails

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

Parameter name

Description

apiKey*

API Key to access your OpManager server.

interfaceName*

Name of the interface - Managed Entity name as seen in the URL of interface snapshot page OR 'interfaceName' property value in the listInterfaces API response

period*

Period for which the interface graph is required. [Example: twelvehours,Today,twfourhours,Yesterday,thisweek,Last_7_Days,lastweek,thismonth,Last_30_Days,Last_Month,custom]

startDate

From Date. This paramete is applicable only if 'custom' time is opted in period param value

endDate

To Date. This param is applicable only if 'custom' time is opted in period param value

getInterfaces

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

Parameter name

Description

apiKey*

API Key to access your OpManager server.

name*

Name of the parent device - Managed Entity name of the parent device as seen in the URL of device snapshot page OR 'deviceName' property value in the listDevices API response

getInterfaceNotes

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

Parameter name

Description

apiKey*

API Key to access your OpManager server.

interfaceName*

Name of the interface - Managed Entity name as seen in the URL of interface snapshot page OR 'interfaceName' property value in the listInterfaces API response

getInterfaceGraphs

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

Parameter name

Description

apiKey*

API Key to access your OpManager server.

interfaceName*

Name of the interface - Managed Entity name as seen in the URL of interface snapshot page OR 'interfaceName' property value in the listInterfaces API response

graphName

isFluidic

Set as 'true' by default (for internal purpose)

period

Period for which the interface graph is required. [Example: twelvehours(16),Today(6),twfourhours(3),Yesterday(7),thisweek(8),Last_7_Days(4),lastweek(9),thismonth(10),Last_30_Days(5),Last_Month(11),custom(23)]

startDate

From Date. This parameter is applicable only if 'custom' time is opted in period param value

endDate

To Date. This parameter is applicable only if 'custom' time is opted in period param value

Monitoring

getDeviceAssociatedMonitors

Method: GET

Description: Lists all the monitors associated to the device

Sample URL: https://localhost:8060/api/json/device/getDeviceAssociatedMonitors?apiKey=***************&name=devicename

Parameter name

Description

apiKey*

API Key to access your OpManager server.

name*

Name of the device

Performance Monitors

getPerformanceMonitors

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

Parameter name

Description

apiKey*

API Key to access your OpManager server.

deviceName*

Name of the device

category*

Category of the device

type*

Type of the device

getPerformanceMonitorDetails

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

Parameter name

Description

Note

apiKey*

API Key to access your OpManager server.

-

name*

Name of the device

-

policyName*

Policy name of the performance monitor

-

graphName*

Graph name of the performance monitor.

The "policyName" and "graphName" values can be obtained from getDeviceAssociatedMonitors API

checkNumeric*

true (or) false.

-

addPerformanceMonitors

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

Parameter name

Description

Note

apiKey*

API Key to access your OpManager server.

-

name*

Name of the device

-

selectedMonitors*

GraphID of the performance monitor(s) to be added (multiple values separated by commas).

The GraphID value(s) can be obtained from getPerformanceMonitors API

deletePerformanceMonitors

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

Parameter name

Description

Note

apiKey*

API Key to access your OpManager server.

-

name*

Name of the device

-

pollId*

pollId of the performance monitor (multiple values separated by commas).

The pollId value(s) can be obtained from getDeviceAssociatedMonitors API

TestMonitor

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

Parameter name

Description

Note

apiKey*

API Key to access your OpManager server.

-

name*

Name of the device

-

policyName*

Policy name of the monitor

-

graphName*

Graph name of the monitor.

The "policyName" and "graphName" values can be obtained from getDeviceAssociatedMonitors API

instanceName

Instance name (only applicable for MSSQL monitors).

-

Process Monitors

getAssociatedProcessMonitors

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

Parameter name

Description

apiKey*

API Key to access your OpManager server.

deviceName*

Name of the device

associateProcessMonitor

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

Parameter name

Description

Note

apiKey*

API Key to access your OpManager server.

-

deviceName*

Name of the device.

-

processId*

ID of the processes that need to be associated

The processId value(s) can be obtained from getAssociatedProcessMonitors API

getAssociatedServiceMonitors

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

Parameter name

Description

apiKey*

API Key to access your OpManager server.

name*

Name of the device

associateServiceMonitor

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

Parameter name

Description

apiKey*

API Key to access your OpManager server.

deviceName*

Name of the device for which the service to be associated. Give the names by comma separated for bulk association

serviceName*

Name of the service(s) (multiple values separated by commas).

Windows Service Monitors

getDeviceAssociatedWindowsServiceMonitors

Method: GET

Description: Lists the associated Windows Service Monitors for a device

Sample URL: https://localhost:8060/api/json/device/getDeviceAssociatedWindowsServiceMonitors?apiKey=***************&name=devicename

Parameter name

Description

apiKey*

API Key to access your OpManager server.

name*

Name of the device

URL Monitors

listURLMonitors

Method: GET

Description: Lists all the global URL monitors available in OpManager

Sample URL: https://localhost:8060/api/json/admin/listURLMonitors?apiKey=***************

Parameter name

Description

apiKey*

API Key to access your OpManager server.

Script Monitors

listScriptMonitors

Method: GET

Description: Lists all the script templates available in OpManager

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

Parameter name

Description

apiKey*

API Key to access your OpManager server.

Notifications

listNotificationProfiles

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

Parameter name

Description

apiKey*

API Key to access your OpManager server.

isGlobal

false - for Device Specific Profile Filters.

profileFilter

All - For Global profiles and for other type of profiles (Send+Email, Send+SMS, Send+Modem+SMS, Run+System+Command, etc.)

deviceName

Name of the devices to be associated

associateNotificationProfiles

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

Parameter name

Description

apiKey*

API Key to access your OpManager server.

deviceName*

Name of the devices to be associated

profiles*

ProfileID of the profiles to be associated.

Reports

getAdvancedReportData

Method: GET

Description: getAdvancedReportData functions based on lazy loading. When the first API call is made, it will give the count of the rows present in the report as a response. The subsequent API calls will bring the appropriate response based on the specified params.

Example:
Make the listAllAdvancedReports API call to get the reportId data. Then make the getAdvancedReportData API call subsequently.

First API Call: https://<Host>:<port>/api/json/reports/getAdvancedReportData?getColumnDetails=true&reportID=901&apiKey=***********************************

Params: getColumnDetails=true, reportID=901, apiKey=**********************************************

Response:
{
deviceNameIndex: 0
groupByCount: 0
groupHeader: []
headers: ["Device Name", "Status", "Availability (%)"]
moduleId: "1"
records: 4289
total: 86
totalColumns: 3
}

Note: Records represent the total number of rows present in the report. Depending on the records (the number of rows) you can decide the number of API calls to be made. In a single API call, you can get up to 1000 rows. So, if your report has 5000 rows totally, you have to make 5 consecutive API calls to get the complete data.

Consecutive API calls

https://<Host>:<port>/api/json/reports/getAdvancedReportData?fetchFromRowNumber=1&rowsToFetch=1000&reportId=901&apiKey=***********************************
https://<Host>:<port>/api/json/reports/getAdvancedReportData?fetchFromRowNumber=1001&rowsToFetch=1000&reportId=901&apiKey=***********************************
https://<Host>:<port>/api/json/reports/getAdvancedReportData?fetchFromRowNumber=2001&rowsToFetch=1000&reportId=901&apiKey=***********************************
https://<Host>:<port>/api/json/reports/getAdvancedReportData?fetchFromRowNumber=3001&rowsToFetch=1000&reportId=901&apiKey=***********************************
https://<Host>:<port>/api/json/reports/getAdvancedReportData?fetchFromRowNumber=4001&rowsToFetch=289&reportId=901&apiKey=***********************************

Parameter name

Description

rowsToFetch

Number of Rows to Fetch -- range is from 1 to 1000

fetchFromRowNumber

Specifies the starting number of rows to fetch the data.

getOnlyColumnDetails

Specify either true or false. If true, Report MetaData will be returned, if false, remaining parameters should be sent mandatory.

reportId

Unique and varies for each report

apiKey

An apiKey enables you to access OpManager server.

getReportsList

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

Parameter name

Description

apiKey*

API Key to access your OpManager server.

isFavouriteNeeded

Boolean value to show favourites reports or not.

hideintegratedReports

Boolean value to show integrated reports or not.

hideHardwareReport

Boolean value to show hardware report or not.

getReportsData

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

Parameter name

Description

apiKey*

API Key to access your OpManager server.

reportID

Unique ID for individual reports.

viewAs

Format to view the resultant report data.

time

The time period to fetch the report data.

isExcludeDays

Boolean value to exclude days or not.

excludedDays

The day to be excluded in report data.

category

The category to view the report data.

logicalGroup

The logical group to view the report data.

bview

The business view to view the report data.

timeWindow

The time window to fetch the report data.

showType

To show the top or bottom contents of report data.

top

To show the top of the reports data.

startTime

Start time of custom time period.

endTime

End time of custom time period.

startHour

Start hour of custom time period.

endHour

End hour of custom time period.

customerId

Probe Id to be filtered.

customerName

Probe name to be filtered.

fromEmailid

From mail id for report to be sent.

toEmailid

To mail id for report to be sent.

emailSubject

Mail Subject

isBusinessHour

Boolean value to show business hour data or not.

businessRuleID

ID of the business rule created previously.

listBusinessRules

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

Parameter name

Description

apiKey*

API Key to access your OpManager server.

addBusinessRules

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"}

Parameter name

Description

apiKey*

API Key to access your OpManager server.

description

Description about the business rule.

businessRuleName

Name of the business hour rule.

timeSettings

Time configuration from Monday to Sunday.

deleteBusinessRules

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

Parameter name

Description

apiKey*

API Key to access your OpManager server.

businessRuleId

ID of the business hour rule.

viewBusinessRules

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

Parameter name

Description

apiKey*

API Key to access your OpManager server.

businessRuleId

ID of the business hour rule.

updateBusinessRules

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

Parameter name

Description

apiKey*

API Key to access your OpManager server.

description

Description about the business rule.

businessRuleName

Name of the business hour rule.

timeSettings

Time configuration From Monday to Sunday.

businessRuleId

ID of the business hour rule.

getReportData

Method: POST

Description: The api to fetch data of report builder reports.

Sample URL: https://localhost:8060/api/json/v2/device/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

Parameter name

Description

apiKey*

API Key to access your OpManager server.

deviceList

Device list to fetch the report data.

monitorList

Monitor list to fetch the report data.

timePeriod

Time period to fetch the report data.

view

Viewing report in table/graph format.

tableView

To show the report data in instance/Monitor wise.

combinedTable

Boolean value to show combined table results.

startDate

Start date of the report data.

endDate

End date of the report data.

startHour

Start hour of the report data.

endHour

End hour of the report data.

timeWindow

The time window to fetch the report data.

listAllAdvancedReports

Method: GET

Description: This api can be used to fetch all the created Advanced Reports.

Sample URL: https://: /api/json/reports/listAllAdvancedReports?apiKey=***********************************

Parameter name

Description

apiKey

An apiKey enables you to access OpManager server.

Subnets

listSubnets

Method: GET

Description: Lists all the Subnets monitored in OpManager

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

Parameter name

Description

apiKey*

API Key to access your OpManager server.

Wireless

getWirelessNetworkDetails

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

Parameter name

Description

apiKey*

API Key to access your OpManager server.

deviceName*

Name of the WLC device (Managed Entity name as seen in the URL of device snapshot page OR 'deviceName' property value in the listDevices API response)

getWirelessAPList

Method: GET

Description: Lists all Access Points in the WLC Device.

Sample URL: https://localhost:8060/api/json/wireless/getWirelessAPList?apiKey=***************&deviceName=CiscoWirelessController

Parameter name

Description

apiKey*

API Key to access your OpManager server.

deviceName*

Name of the WLC device (Managed Entity name seen in the URL of device snapshot page OR 'deviceName' property value in the listDevices API response)

getSSIDClientList

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

Parameter name

Description

apiKey*

API Key to access your OpManager server.

deviceName*

Name of the WLC device (Managed Entity name as seen in the URL of device snapshot page OR 'deviceName' property value in the listDevices API response)

getClientDetails

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

Parameter name

Description

apiKey*

API Key to access your OpManager server.

deviceName*

Name of the WLC device (Managed Entity name as seen in the URL of device snapshot page OR 'deviceName' property value in the listDevices API response)

ssidName*

SSID name of the wireless network associated to WLC