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 has to passed as a parameter in every API request made. First, generate an API key.

Generate API Key

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

Admin Module

addServiceMonitor

Method: POST

This API call is used to add a service monitor in OpManager.

Sample URL: http://localhost:8060/api/json/admin/addServiceMonitor?apiKey=081c9ac51ba16ab061d5efee583dcd2f&autoDiscovery=false&serviceName=test2&portNumber=119&timeOut=5&failureThreshold=1

Parameter name

Description

apiKey*

API Key to access your OpManager server.

serviceName*

Service Name to be added

portNumber

Port Number of the service

timeOut*

Timeout value in seconds. Default value 0.

failureThreshold*

Consecutive time value to generate service down alert. Default value 1.

autoDiscovery*

True - Need to check and add this service during discovery. Otherwise false

addSysLogForwarder

Method: POST

This API call is used to add a service monitor in OpManager.

Parameter name

Description

apiKey*

API Key to access your OpManager server.

destHost*

Destination Host.

destPort*

Destination Port(0 – 65536)

addSysLogRule

Method: POST

Add SysLog Forwarder

Parameter name

Description

apiKey* -

API Key to access your OpManager server.

ruleName*

Name of the rule

facilityName*

SysLog Facility

severityList*

SysLog Severity(Comma Seperated)

alertSeverity*

OpManager Alert Severity

alarmMessage*

OpManager Alert Message

matchString

String matched with incoming syslog message

consecutiveTime*

consecutive time

timeInterval*

time interval
(if rearmFacilityName selcted then rearmSeverityList shoule be selected)

rearmFacilityName

facility name for rearm syslog

rearmSeverityList

severity list for rearm syslog

rearmMatchString

String matched with incoming syslog for rearm

Alerts

acknowledgeAlarm

Method: POST

Allows to acknowledge an alarm.

Sample URL: http://localhost:8060/api/json/alarm/acknowledgeAlarm?apiKey=081c9ac51ba16ab061d5efee583dcd2f&entity=222222222

Parameter name

Description

apiKey*

API Key to access your OpManager server.

entity

Entity of the alarm.

addEvent

Method: POST

Adds an event.

Sample URL: http://localhost:80/api/json/events/addEvent?apiKey=3d4d1f45e4c445eb52b9f1c51bc7c1ca&source=Cisco2081_router&severity=1&message=DownStatus&alarmCode=Threshold-DOWN&entity=Cisco2081_router

Parameter name

Description

apiKey* -

API Key to access your OpManager server.

entity -

Entity of the alarm.

source* -

Name of the source device of the event.

severity* -

The severity of the event. Following are the severity levels and its ID:
Critical - 1
Trouble - 2
Attention - 3
Service Down - 4

message* -

The message that is displayed when the event is generated.

alarmCode -

Unique string used to trigger the event. Eg:-Threshold-DOWN

entity -

Uniquely identifies the failure object within the source.Events will be correlated into alarms according to the entity field. Multiple events with the same entity will be grouped as a single alarm.

eventType -

Description of the event type

addNotes

Method: POST

Adds notes to an alarm.

Sample URL: http://localhost:8060/api/json/alarm/addNotes?apiKey=081c9ac51ba16ab061d5efee583dcd2f¬es=test&entity=222222222

Parameter name

Description

apiKey* -

API Key to access your OpManager server.

entity* -

Entity of the alarm.

notes* -

Text that has to be added as notes to the alarm.

API Reference

OpManager REST API

How OpManager REST APIs work?

Generate API Key

Admin Module

addServiceMonitor

addSysLogForwarder

addSysLogRule

Alerts

acknowledgeAlarm

addEvent

addNotes