OpManager_REST_API - OpManager help cn

OpManager提供了REST API，可以向OpManager添加数据或者从OpManager中获取数据。使用API可以把OpManager和第三方IT管理系统或服务台软件进行集成。

API通过API密钥使用。每个OpManager用户的API密钥都不一样，并且要作为API请求的一个参数。首先要生成API密钥。

OpManager REST API参考

REST API

方法

描述

参数

示例URL

管理模块

addServiceMonitor

POST

添加服务监视器

apiKey* -访问OpManager服务器的API密钥。

serviceName* - 要添加的服务名称。

portNumber* -服务的端口号

timeOut* -超时值，以秒为单位。默认值为0。

failureThreshold* - 生成服务停止告警的连续轮询次数。默认值为1。

autoDiscovery* - True - 在发现的时候检查并添加该服务。false - 发现的时候不检查。

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

addSysLogForwarder

POST

添加SysLog转发

apiKey* -访问OpManager服务器的API密钥。

destHost* - 目标主机。

destPort* -目标端口。(0 – 65536)

http://localhost:8060/api/json/admin/addSysLogForwarder?apiKey=081c9ac51ba16ab061d5efee583dcd2f&destHost=opman-k8r2s-64-3&destPort=515

addSysLogRule

POST

添加SysLog规则

apiKey* - 访问OpManager服务器的API密钥。

ruleName* - 规则名称

facilityName* - SysLog设施

severityList* - SysLog严重性（使用英文逗号隔开）

alertSeverity* - OpManager告警严重性

alarmMessage* - OpManager告警信息

matchString - 收到的Syslog信息中配置的字符串

consecutiveTime* - 重试次数

timeInterval* - 时间间隔
（如果选择了rearmFacilityName，那么也应该选择rearmSeverityList）

rearmFacilityName - 重置syslog的设施名称

rearmSeverityList - 重置syslog的严重性

rearmMatchString - 重置syslog匹配的字符串

http://localhost:8060/api/json/admin/addSysLogRule?apiKey=081c9ac51ba16ab061d5efee583dcd2f&alertSeverity=1&facilityName=auth&ruleName=test11&alarmMessage=test&severityList=alert

addTrapForwarder

POST

添加陷阱转发器

apiKey* -访问OpManager服务器的API密钥。

destHost* - 目标主机。

destPort* - 目标端口。

http://localhost:8060/api/json/admin/addTrapForwarder?apiKey=081c9ac51ba16ab061d5efee583dcd2f&destHost=opman-k8r2s-64-6&destPort=165

deleteCredential

POST

删除凭证

apiKey* -访问OpManager服务器的API密钥。

credentialName* - 凭证名称。

isSNMPV3 – true或false。

http://localhost:8060/api/json/admin/deleteCredential?apiKey=081c9ac51ba16ab061d5efee583dcd2f&credentialName=Public

deleteServiceMonitor

POST

删除服务监视器

apiKey* -访问OpManager服务器的API密钥。

serviceName* - Name of the service to be deleted

http://localhost:8060/api/json/admin/deleteServiceMonitor?apiKey=081c9ac51ba16ab061d5efee583dcd2f&serviceName=test2

deleteWindowsServiceMonitor

POST

删除Windows服务监视器

apiKey* - 访问OpManager服务器的API密钥。

serviceDisplayName* - 要删除服务的显示名称

http://localhost:8060/api/json/admin/deleteWindowsServiceMonitor?apiKey=081c9ac51ba16ab061d5efee583dcd2f&oper=del&serviceDisplayName=Windows+CardSpace&id=13

getCredentialDetails

GET

获取凭证信息

apiKey* - 访问OpManager服务器的API密钥。

credentialName* - 凭证名称。

type* - 设备类型，例如：Windows、Linux、SNMP v1/v2、SNMP v3或Vmware。

http://localhost:8060/api/json/admin/getCredentialDetails?apiKey=081c9ac51ba16ab061d5efee583dcd2f&credentialName=Public&type=SNMP v1/v2

getDBMaintenanceData

GET

获取数据库维护配置

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/admin/getDBMaintenanceData?apiKey=081c9ac51ba16ab061d5efee583dcd2f

getFlowRate

GET

获取SysLog流速率

apiKey* -访问OpManager服务器的API密钥。

http://localhost:8060/api/json/admin/getFlowRate?apiKey=081c9ac51ba16ab061d5efee583dcd2f

getServiceDetails

GET

获取服务监视器信息

apiKey* - API Key

serviceName* - Name of the Service

http://localhost:8060/api/json/admin/getServiceDetails?apiKey=081c9ac51ba16ab061d5efee583dcd2f&serviceName=DNS

getSystemSettingsDetails

GET

获取OpManager系统设置信息。

apiKey* -访问OpManager服务器的API密钥。

http://localhost:8060/api/json/admin/getSystemSettingsDetails?apiKey=081c9ac51ba16ab061d5efee583dcd2f

getWindowsServiceMonitor

GET

获取Windows服务监视器信息

apiKey* - 访问OpManager服务器的API密钥。

serviceDisplayName* - 服务的显示名称

http://localhost:8060/api/json/admin/getWindowsServiceMonitor?apiKey=081c9ac51ba16ab061d5efee583dcd2f&serviceDisplayName=Alerter

setDBMaintenanceData

POST

配置数据库维护。

apiKey* - 访问OpManager服务器的API密钥。

alarmscount - 保留的告警数量。

rawdata - 详细统计数据。

hourlydata - 小时统计数据。

dailydata - 每日统计数据。

http://localhost:8060/api/json/admin/setDBMaintenanceData?apiKey=081c9ac51ba16ab061d5efee583dcd2f&alarmscount=10000&dailydata=365&rawdata=7&hourlydata=30

updateServiceMonitor

POST

更新服务监视器信息

apiKey* -访问OpManager服务器的API密钥。

serviceName* - 要更新的服务名称

timeOut* - 要更新的超时值

failureThreshold* - 要更新的重试次数

http://localhost:8060/api/json/admin/updateServiceMonitor?apiKey=081c9ac51ba16ab061d5efee583dcd2f&serviceName=test2&timeOut=10&failureThreshold=3

updateSystemSettingsDetails

GET

更新系统设置。

apiKey* - 访问OpManager服务器的API密钥。

ALARMMESSAGELENGTH - 任意正整数。

CLILOG – false/true。

DATACOLLECTIONRATE - true/false

DEBUGPRINTS - false/true

POLLPERSECOND - true/false

SCHEDULERRATE - false/true

SNMPLOG - false/true

SNMPV3LOG - false/true

ShowAds - true/false

WMILOG - false/true

benchmarkupload - enable/disable

metrackupload - enable/disable

quicklinks – enable/disable

http://localhost:8060/api/json/admin/updateSystemSettingsDetails?apiKey=081c9ac51ba16ab061d5efee583dcd2f&SNMPV3LOG=false&ShowAds=true&ALARMMESSAGELENGTH=100&DATACOLLECTIONRATE=true&metrackupload=enable&quicklinks=enable&POLLPERSECOND=true&DEBUGPRINTS=false&WMILOG=false&SCHEDULERRATE=false&SNMPLOG=false&benchmarkupload=enable&CLILOG=false

updateTheme

POST

更改界面主题。

apiKey* -访问OpManager服务器的API密钥。

selectedSkin* - 要设置的主题名称

http://localhost:8060/api/json/admin/updateTheme?apiKey=081c9ac51ba16ab061d5efee583dcd2f&selectedSkin=Olive Green

updateWindowsServiceMonitor

POST

更新Windows服务监视器信息

apiKey* - 访问OpManager服务器的API密钥。

serviceDisplayName* - 服务的显示名称

failureThreshold* - 要更新的重试次数

actionType* -要更新的动作类型。值可以是：0/1/2, 0 - 无动作；1 - 重启服务；2 - 重启服务器

http://localhost:8060/api/json/admin/updateWindowsServiceMonitor?apiKey=081c9ac51ba16ab061d5efee583dcd2f&serviceDisplayName=Windows+CardSpace&actionType=0&failureThreshold=2

listPluginEvents

GET

获取由插件生成的事件

apiKey* - 访问OpManager服务器的API密钥。

plugginName* - 插件的名称。

eventTime* - 事件生成的周期。（例如全部事件，就是All）

http://localhost:8060/api/json/alarm/listPluginEvents?apiKey=6d36ff8426cff396b81b248e5c458604&pluginName=All&eventTime=All

getPluginEventCount

GET

获取由插件生成事件的数量。

apiKey* - 访问OpManager服务器的API密钥。

fromTime* - 开始时间。

toTime* - 结束时间。

http://localhost:8060/api/json/alarm/getPluginEventCount?apiKey=6d36ff8426cff396b81b248e5c458604&fromTime=2014-2-20 13:32:8&toTime=2014-2-20 14:2:8

getPluginDetails

GET

获取安装的插件信息

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/admin/getPluginDetails?apiKey=081c9ac51ba16ab061d5efee583dcd2f

showAssociateDevices

POST

显示关联的设备列表。

apiKey* - 访问OpManager服务器的API密钥。

selectedOption* - 选择的选项(manual)。

http://localhost:8060/api/json/admin/showAssociateDevices?selectedOption=MANUAL&apiKey=6d36ff8426cff396b81b248e5c458604

saveProfileTimeSettings

POST

更新通知配置文件间隔。

apiKey* - 访问OpManager服务器的API密钥。

profileID* - 通知配置文件ID。

criteriaID* - 条件ID。

http://localhost:8060/api/json/admin/saveProfileTimeSettings?apiKey=081c9ac51ba16ab061d5efee583dcd2f&profileID=1&criteriaID=1

saveProfileCriteria

POST

更新通知配置文件条件。

apiKey* - 访问OpManager服务器的API密钥。

profileID* - 配置文件ID。

chkThresholdCriteria* – 是否坚持配置文件条件（Yes或No）。

selectAllThresholdMonitors* – 选择所有阈值监视器（All）。

http://localhost:8060/api/json/admin/saveProfileCriteria?apiKey=081c9ac51ba16ab061d5efee583dcd2f&profileID=1&chkThresholdCriteria=Yes&SelectAllThresholdMonitors=all

listProfileCriteria

GET

列出OpManager创建的所有配置文件条件。

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/admin/listProfileCriteria?apiKey=081c9ac51ba16ab061d5efee583dcd2f

getDeviceListForTestScript

GET

列出测试脚本设备。

apiKey* - 访问OpManager服务器的API密钥。

executedFrom* - 执行的脚本名称（Local Server）。

http://localhost:8060/api/json/admin/getDeviceListForTestScript?apiKey=081c9ac51ba16ab061d5efee583dcd2f&executeFrom=Local Server

upadateTrapParser

POST

更新陷阱解析器

apiKey* - 访问OpManager服务器的API密钥。

version* - 版本。

oid* - 设备OID。

TrapParserName* - 陷阱解析器名称。

http://localhost:8060/api/json/admin/upadateTrapParser?apiKey=081c9ac51ba16ab061d5efee583dcd2f&version=v2&oid='.2.2.2.2.2.'&trapParserName=testing

updateLanguageSettings

POST

更新语言设置

apiKey* - 访问OpManager服务器的API密钥。

languageSelected* - 选择的语言。

http://localhost:8060/api/json/admin/updateLanguageSettings?apiKey=6d36ff8426cff396b81b248e5c458604&languageSelected=fr_FR

getLanguageSettings

GET

获取语言设置s。

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/admin/getLanguageSettings?apiKey=1d626117b2ac31145ce6bca49bb0458b

listProfileNamesAndTypes

GET

列出OpManager创建的所有通知配置文件名称和类型。

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/admin/listProfileNamesAndTypes?apiKey=081c9ac51ba16ab061d5efee583dcd2f

updateNotificationProfile

POST

更新通知配置文件。

apiKey* - 访问OpManager服务器的API密钥。

toAddress* – 接收邮件地址。

MAILFORMAT* – 邮件格式（HTML、BOTH或PLAIN)。

server* – 邮件服务器（SMTP）。

profileType* – 通知配置文件类型。

portNumber* – 邮件服务器端口号。

message* – 邮件通知消息。

fromAddress* – 发送邮件地址。

ID* – 配置文件ID。

subject* – 邮件通知配置文件的标题。

http://localhost:8060/api/json/admin/updateNotificationProfile?apiKey=081c9ac51ba16ab061d5efee583dcd2f&toAddress=rejoe@testdomain.com&MAILFORMAT=BOTH&server=SMTP&profileType=Send Email&portNumber=25&message=Test Message&fromAddress=re@gmail.com&ID=2&subject=test

editNotificationProfile

POST

编辑通知配置文件。

apiKey* - 访问OpManager服务器的API密钥。

profileType* - 配置文件类型。

ID* - Profile ID。

http://localhost:8060/api/json/admin/editNotificationProfile?apiKey=081c9ac51ba16ab061d5efee583dcd2f&profileType=Send Email&ID=2

addNotificationProfile

POST

添加新的通知配置文件

apiKey* - 访问OpManager服务器的API密钥。

toAddress* – 接收邮件地址。

MAILFORMAT* – 邮件格式（HTML、BOTH或者PLAIN）。

server* – 邮件服务器（SMTP）。

profileType* – 通知配置文件类型。

portNumber* – 邮件服务器端口号。

message* – 邮件通知消息。

fromAddress* – 发送邮件地址。

name* – 通知配置文件名称。

subject* – 邮件通知配置文件主题。

http://localhost:8060/api/json/admin/addNotificationProfile?apiKey=081c9ac51ba16ab061d5efee583dcd2f&toAddress=rejoe@testdomain.com&name=testemail&MAILFORMAT=BOTH&server=SMTP&profileType=Send Email&portNumber=25&message=Test Message&fromAddress=kar@gmail.com&subject=test

deleteNotificationProfile

POST

删除通知配置文件

apiKey* - 访问OpManager服务器的API密钥。

ID* - 通知配置文件ID。

http://localhost:8060/api/json/admin/deleteNotificationProfile?apiKey=081c9ac51ba16ab061d5efee583dcd2f&ID=2

getNotificationProfileList

GET

列出通知配置文件。

apiKey* - 访问OpManager服务器的API密。

http://localhost:8060/api/json/admin/getNotificationProfileList?apiKey=081c9ac51ba16ab061d5efee583dcd2f

deleteAgentDetails

POST

删除代理设备

apiKey* - 访问OpManager服务器的API密钥。

Id* - 代理ID。

oper* - 执行的操作。

selectedDevices* - 要删除的设备。

http://localhost:8060/api/json/admin/deleteAgentDetails?id=1&oper=del&selectedDevices=1392094715&apiKey=6d36ff8426cff396b81b248e5c458604

updateAgentDetails

POST

更新代理设备信息

apiKey* - 访问OpManager服务器的API密钥。

agentKey* - 监视代理密钥。

mappedDevice* - 关联的设备名称。

http://localhost:8060/api/json/admin/updateAgentDetails?agentKey=1392094715&apiKey=6d36ff8426cff396b81b248e5c458604&mappedDevice=640

显示代理信息

GET

显示安装的代理信息

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/admin/showAgentDetails?apiKey=6d36ff8426cff396b81b248e5c458604

deleteFailOverDetails

POST

删除热备服务信息

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8070/api/json/admin/deleteFailOverDetails?apiKey=6d36ff8426cff396b81b248e5c458604

updateFailOverDetails

POST

更新热备服务器信息

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8070/api/json/admin/updateFailOverDetails?apiKey=6d36ff8426cff396b81b248e5c458604

listFailOverDetails

GET

列出热备服务器信息

apiKey* - 访问OpManager服务器的API密钥。

serviceName* - 热备设备名称。

http://localhost:8060/api/json/admin/listFailOverDetails?serviceName=DNS&apiKey=081c9ac51ba16ab061d5efee583dcd2f

SubmitQuery

POST

执行一个语句并返回结果

apiKey* - 访问OpManager服务器的API密钥。

query* - 要执行的语句。

http://localhost:8060/api/json/admin/SubmitQuery?apiKey=081c9ac51ba16ab061d5efee583dcd2f&query=select * from UserPasswordTable

registerLicense

POST

注册许可文件

apiKey* - 访问OpManager服务器的API密钥。

fileName* - 许可文件名称。

http://localhost:8060/api/json/admin/registerLicense?apiKey=6d36ff8426cff396b81b248e5c458604

licenseDetails

GET

获取许可文件信息

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/admin/licenseDetails?apiKey=081c9ac51ba16ab061d5efee583dcd2f

getCredentialMappedDevices

GET

指定凭证关联的设备列表

apiKey* - 访问OpManager服务器的API密钥。

credentialName* - 凭证名称。

http://localhost:8060/api/json/admin/getCredentialMappedDevices?apiKey=081c9ac51ba16ab061d5efee583dcd2f&credentialName=Public

sendSIF

POST

发送支持信息文件。

apiKey* - 访问OpManager服务器的API密钥。

customerName* - 客户名称/邮件地址。

phone* - 联系电话。

subject* - 邮件标题。

userMessage* - 邮件内容。

fromAddress* - 发送邮件地址。

supportFile* - 文件名或zip文件。

http://localhost:8060/api/json/admin/sendSIF?apiKey=6d36ff8426cff396b81b248e5c458604&customerName=administrator@opmanager.com&phone=7781&subject=OpmLogs&userMessage=opm logs for analyzing issue&fromAddress=mohamedthahir.n@testdomain.com&supportFile=OpMan_11200_Feb_20_2014_15_58_30.zip

createSIF

GET

创建支持信息文件（zip）

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/admin/createSIF?apiKey=081c9ac51ba16ab061d5efee583dcd2f

viewLogs

GET

列出OpManager创建的所有日志文件

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/admin/viewLogs?apiKey=081c9ac51ba16ab061d5efee583dcd2f

updateJvmHeapSize

POST

更新JVM Heap大小

apiKey* - 访问OpManager服务器的API密钥。

jvmHeapSize* - 新的JVM Heap大小

http://localhost:8060/api/json/admin/updateJvmHeapSize?apiKey=6d36ff8426cff396b81b248e5c458604&JvmHeapSize=5120

generateHeapDump

POST

生成Heap dump文件。

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/admin/generateHeapDump?apiKey=081c9ac51ba16ab061d5efee583dcd2f

GetThreadDump

GET

获取thread dump。

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/admin/GetThreadDump?apiKey=83155f195334a19df5e58a8a33a6f804

GetSystemInformation

GET

获取系统信息。

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/admin/GetSystemInformation?apiKey=081c9ac51ba16ab061d5efee583dcd2f

getProcessTemplateAssociatedDevices

GET

获取关联到设备的进程模板。

apiKey* - 访问OpManager服务器的API密钥。

protocol* - 协议类型。

templateName* - 模板/进程名称。

http://localhost:8060/api/json/admin/getProcessTemplateAssociatedDevices?apiKey=1d626117b2ac31145ce6bca49bb0458b&protocol=WMI&templateName=sqlservr.exe

GetRebrandDetails

GET

获取换标信息。

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/admin/GetRebrandDetails?apiKey=081c9ac51ba16ab061d5efee583dcd2f

rebrandOpManager

GET

给产品换标。

apiKey* - 访问OpManager服务器的API密钥。

productName* - 换标后的产品名称。

http://localhost:8060/api/json/admin/rebrandOpManager?apiKey=6d36ff8426cff396b81b248e5c458604&productName=ServerMonitoringTool

regenerateAPIKey

GET

生成API密钥

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/admin/regenerateAPIKey?apiKey=081c9ac51ba16ab061d5efee583dcd2f

deleteSecondaryMailServer

POST

删除备用邮件服务器。

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/admin/deleteSecondaryMailServer?apiKey=081c9ac51ba16ab061d5efee583dcd2f

deleteDataCollectionRow

POST

删除收集的数据

apiKey* - 访问OpManager服务器的API密钥。

time* - 数据收集时间

value – 数据收集值。

http://localhost:8060/api/json/diagnostics/deleteDataCollectionRow?apiKey=6d36ff8426cff396b81b248e5c458604&id=6&oper=del

getDataCollectionRowAsList

GET

Gets data collection list – Polls per second

apiKey* - 访问OpManager服务器的API密钥。

fromTime* - Data collection From time

toTime* – Data collected To time。

http://localhost:8060/api/json/diagnostics/getDataCollectionRowAsList?apiKey=081c9ac51ba16ab061d5efee583dcd2f&fromTime=2013-12-21 00:01:15&toTime=2013-12-21 23:59:15

getActualScheduleRate

GET

Gets actual schedule rate

apiKey* - 访问OpManager服务器的API密钥。

fromTime* - Data collection From time

ToTime* – Data collected To time。

http://localhost:8060/api/json/diagnostics/getActualScheduleRate?apiKey=081c9ac51ba16ab061d5efee583dcd2f&fromTime=2013-12-21 00:01:15&toTime=2013-12-21 23:59:15

getDataCollectionRow

GET

获取data collection row – Polls per second

apikey* - 访问OpManager服务器的API密钥。

fromTime* - Data collection from time

toTime* – Data collected to time。

http://localhost:8060/api/json/diagnostics/getDataCollectionRow?apiKey=081c9ac51ba16ab061d5efee583dcd2f&fromTime=2013-12-21 00:01:15&toTime=2013-12-21 23:59:15

deleteDomain

POST

Deletes the domain name。

apiKey* - 访问OpManager服务器的API密钥。

domainName* - Name of the domain。

http://localhost:8060/api/json/admin/deleteDomain?apiKey=081c9ac51ba16ab061d5efee583dcd2f&domainName=ZOHOCORP

addUrl

POST

添加new URL monitor

apiKey* - 访问OpManager服务器的API密钥。

pollInterval* - Poll Interval。

failureThreshold* - Failure threshold value。

errorContent* - Error content。

urlName* - Name of the URL。

password* - Password。

url* - URL to be moniored。

cookie* - ACCEPT or REJECT。

queryString - Search string。

deviceName* - Device name。

matchContent - Matching content to search for。

userName – Username。

method* - POST or GET。

timeout* - Timeout interval。

http://localhost:8060/api/json/admin/addUrl?apiKey=5070623c57db770f93ca914dc7b598f8&pollInterval=5&failureThreshold=1&errorContent=&urlName=test&password=&url=http://test&cookie=ACCEPT&queryString=&deviceName=undefined&matchContent=&userName=&method=G&timeout=25

Alarm Escalation

addAlarmEscalationRules

POST

添加告警升级规则

apiKey* -访问OpManager服务器的API密钥。

rulename* - Alarm escalation rule name。

interval* - interval for escalation。

alarmlife* - period of alarm。

units* - quantity/count。

severity* - severity of escalation。

category* - alarm escalation category。

notificationType* - Type of notification eg., SMS or EMAIL。

ackStatus – acknowledgement status eg. diable. Will be enabled by default。

if notificationType=SMS,
number – number to which sms is to be sent。
smsMessage – SMS message。

if notificationType=EMAIL,
fromemailid – Email id from which the escalate notification being sent。
toemailid – Email id to whom the notification has to be sent。
subject – Subject of escalate notification。
message – Alarm escalation message。

http://localhost:8060/api/json/admin/addAlarmEscalationRules?apiKey=081c9ac51ba16ab061d5efee583dcd2f&category=Server&emailNotify=true&alarmlife=1&severity=1&message=test&interval=5&fromemailid=rejoe@testdomain.com&period=1&server=smtp&portNumber=25&smsNotify=false&rulename=test2&units=un&alarmLifeUnit=1&toemailid=rejoe@testdomain.com&selectedBV=test&subject=test

deleteAlarmEscalationRules

POST

Deletes 告警升级规则。

apiKey* - api key。
rulename* - Alarm escalation rule names。 (comma-separated)

http://localhost:8060/api/json/admin/deleteAlarmEscalationRules?apiKey=081c9ac51ba16ab061d5efee583dcd2f&rulename=test2

showEscalationRules

GET

Provides all 告警升级规则 available。

apiKey* - api key。

http://localhost:8060/api/json/admin/showEscalationRules?apiKey=081c9ac51ba16ab061d5efee583dcd2f

updateAlarmEscalationRules

POST

Updates the Alarm Escalation Rule。

apiKey* - api key。
rulename* - Alarm escalation rule name。
interval* - interval for escalation。
alarmlife* - period of alarm。
units* - quantity/count。
severity* - severity of escalation。
category* - alarm escalation category。
notificationType* - Type of notification eg., SMS or EMAIL。

if notificationType=SMS,
number – number to which sms is to be sent。

smsMessage – SMS message。

if notificationType=EMAIL,
fromemailid – Email id from which the escalate notification being sent。

toemailid – Email id to whom the notification has to be sent。

subject – Subject of escalate notification。

message – Alarm escalation message。

http://localhost:8060/api/json/admin/updateAlarmEscalationRules?apiKey=081c9ac51ba16ab061d5efee583dcd2f&category=Server&emailNotify=true&alarmlife=1&severity=1&message=test&interval=5&fromemailid=rejoe@testdomain.com&period=1&notificationType=Email&portNumber=25&smsNotify=false&rulename=test2&units=un&alarmLifeUnit=1&server=smtp&selectedBV=test20&toemailid=rejoe@testdomain.com&subject=test

viewAlarmEscalationRules

GET

Provides information about the Alarm Escalation rule

apiKey* - 访问OpManager服务器的API密钥。

rulename* - Alarm escalation rule name。

http://localhost:8060/api/json/admin/viewAlarmEscalationRules?apiKey=081c9ac51ba16ab061d5efee583dcd2f&rulename=test2

Alerts

acknowledgeAlarm

POST

Allows to acknowledge an alarm。

apiKey* - 访问OpManager服务器的API密钥。

entity - Entity of the alarm。

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

addDeviceToNProfile

POST

Adds devices to a 通知配置文件 that is already created。

apiKey* -访问OpManager服务器的API密钥。

deviceName* - Name of the device to which the 通知配置文件 has to be associated。

profileName* - Name of the 通知配置文件。

criteria* - There are 26 criteria. Refer the below table。

performanceMonitors* - List of monitors for which you want to trigger the 通知配置文件 when threshold is violated. Add multiple monitors separated by a comma。

http://localhost/api/json/discovery/addDeviceToNProfile?apiKey=ac130763a309fcb1613e0b8a551950a2&deviceName=localhost..testdomainin.com&profileName=TestNotify&criteria=3000000000000000000000000&performanceMonitors=DiskUtilization,Win-CPUUtilization

addEvent

POST

Adds an event。

apiKey* -访问OpManager服务器的API密钥。

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

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

addNotes

POST

Adds notes to an alarm。

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。

http://localhost:8060/api/json/alarm/addNotes?apiKey=081c9ac51ba16ab061d5efee583dcd2f&notes=test&entity=222222222

alarmProperties

GET

Provides the details of an alarm eg: status, acknowledment

apiKey* - 访问OpManager服务器的API密钥。

entity* - Entity of the alarm。

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

clearAlarm

POST

Clears an alarm。

apiKey* - 访问OpManager服务器的API密钥。

entity* - Entity of the alarm。

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

deleteAlarm

POST

Deletes an alarm。

apiKey* - 访问OpManager服务器的API密钥。

entity* - Entity of the alarm。

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

getAnnotation

GET

Provides the notes available for an alarm。

apiKey* - 访问OpManager服务器的API密钥。

entity* - Entity of the alarm。

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

getTopDevicesByAlarms

GET

Provides the list of top deivces by alarms count。

apiKey* - 访问OpManager服务器的API密钥。

eventType* - Type of the Event eg. Trap or Evenlog Alarm

http://localhost:8060/api/json/alarm/getTopDevicesByAlarms?apiKey=081c9ac51ba16ab061d5efee583dcd2f&eventType=THRESHOLD-DOWN

getTopDevicesByEvents

GET

Lists the top devices by events count。

apiKey* - 访问OpManager服务器的API密钥。

eventType* - Type of the Event eg. Trap or Evenlog Alarm

http://localhost:8060/api/json/events/getTopDevicesByEvents?apiKey=081c9ac51ba16ab061d5efee583dcd2f&eventType=THRESHOLD-DOWN

listAlarmEscalationRules

GET

列出OpManager创建的所有the 告警升级规则 created。

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/admin/listAlarmEscalationRules?apiKey=081c9ac51ba16ab061d5efee583dcd2f

listAlarms

GET

列出all the alarms available。

apiKey* - 访问OpManager服务器的API密钥。

deviceName - Name of the device whose alarms alone has to be filtered

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

Category - The category to which the device belongs to. Eg. Router

fromTime - The beginning time for the filter. It should be in yyyy-mm-dd hh:mm:ss format。

toTime - The end time for the filter. It should also be in yyyy-mm-dd hh:mm:ss format。

http://localhost:8060/api/json/alarm/listAlarms?apiKey=081c9ac51ba16ab061d5efee583dcd2f&Category=Server&deviceName=opman-k8r2s-64-3..testdomain.com&severity=1&toTime=2014-02-12 23:59:00&fromTime=2014-02-12 00:01:01

listNotificationProfiles

GET

列出OpManager创建的所有the 通知配置文件 created in OpManager。

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/admin/listNotificationProfiles?apiKey=081c9ac51ba16ab061d5efee583dcd2f

unAcknowledgeAlarm

POST

Allows to unacknowledge an alarm。

apiKey* - 访问OpManager服务器的API密钥。

entity - Entity of the alarm。

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

alarmProperties

GET

Obtains information of the given alarm

apiKey* - 访问OpManager服务器的API密钥。

entity* - Entity (alarm ID)

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

getAlarmList

GET

列出OpManager创建的所有the alarms irrespective of the device/category

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/alarm/getAlarmList?apiKey=081c9ac51ba16ab061d5efee583dcd2f

listEvents

GET

列出OpManager创建的所有generated events

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/events/listEvents?apiKey=6d36ff8426cff396b81b248e5c458604

Device discovery

addDevice

POST

添加a device。

apiKey* - 访问OpManager服务器的API密钥。

deviceName* - Name of the device to be added。

netmask - Enter the netmask for discovering the device。

credentialName - Enter the appropriate credential。

type - 设备类型. Eg. Windows 2008 R2。

displayName - Name of the device that has to be displayed in OpManager。

http://localhost:8060/api/json/discovery/addDevice?apiKey=081c9ac51ba16ab061d5efee583dcd2f&deviceName=opman-k8r2s-64-2.testdomain.com&displayName=opman-k8r2s-64-2.testdomain.com&credentialName=win&netmask=255.255.255.0&type=Windows 2008 R2

addDeviceToGMap

POST

Adds devices to Google map。

apiKey* - 访问OpManager服务器的API密钥。

deviceName* - Name of the device to be added in 业务视图。

latitude* - Latitude of the location where the device is present。

longitude* - Longitude of the location where the device is present。

http://localhost:8060/api/json/discovery/addDeviceToGMap?apiKey=081c9ac51ba16ab061d5efee583dcd2f&latitude=38.625453&deviceName=opman-k8r2s-64-3.testdomain.com&longitude=120.145568

addDomain

POST

Adds a domain in OpManager。

apiKey* - 访问OpManager服务器的API密钥。

domainName - Name of the domain that has to be added。

domainController - Name of the domain controller。

autoLogin - Enable or Disable are the values that has to be entered. Enable - Allow the AD user to login into OpManager even if he/she does not have an account in OpManager. Disable - Does not allow the AD user to login into OpManager if he/she does not have an account in OpManager

loginType** - All users - Allows all users from the AD in that domain。
Selected Groups - Allows selected user groups from the AD in that domain

privilege - Operators - Allows the users in that domain to have Read Only permission to OpManager。
Administrators - Allows the users in that domain to have Full Access permission to OpManager。

readOnlyGroups - Allows the users in that group to have Read Only permission to OpManager。

fullControlGroups - Allows the users in that group to have Full Access permission to OpManager。

http://localhost:8060/api/json/admin/addDomain?apiKey=081c9ac51ba16ab061d5efee583dcd2f&domainController=win2k8master.testdomain.com&autoLogin=true&loginType=All Users&domainName=testdomain

deleteDevice

POST

Deletes a device。

apiKey* - 访问OpManager服务器的API密钥。

deviceName* - Name of the device to be deleted。

http://localhost:8060/api/json/discovery/deleteDevice?apiKey=081c9ac51ba16ab061d5efee583dcd2f&deviceName=opman-k8r2s-64-3.testdomain.com

deleteDomain

POST

Deletes a domain in OpManager。

apiKey* - 访问OpManager服务器的API密钥。

domainName - Name of the domain that has to be deleted。

http://localhost:8060/api/json/admin/deleteDomain?apiKey=081c9ac51ba16ab061d5efee583dcd2f&domainName=ZOHOCORP

discoverNetwork

POST

Discovers a network by providing the IP range。

> Through IP Range

For Ipv4:
apiKey* - 访问OpManager服务器的API密钥。

discoverType* - Format of discovery ie. Range

fromIP* - Starting IP address

toIP* - Ending IP address

netmask* - netMask

credentialName* - credential names as command separated

rediscoverExistingDevices* - rediscovering existing devices (true或false)

For Ipv6:
apiKey* - 访问OpManager服务器的API密钥。

discoverType* - Format of discovery ie. Range

fromIP* - Starting IP address

toIP* - Ending IP address

networkAddress* - network address should be a IPv6 address

credentialName* - credential names as command separated

rediscoverExistingDevices* - rediscovering existing devices (true或false)

> Through CIDR

For Ipv4:
apiKey* - 访问OpManager服务器的API密钥。

discoverType* - Format of discovery ie. CIDR

fromIP* - Starting IP address

maskbit* - Mask bit(1 to 32)

credentialName* - credential names as command separated

rediscoverExistingDevices* - rediscovering existing devices (true或false)

For Ipv6:
apiKey* - 访问OpManager服务器的API密钥。

discoverType* - Format of discovery ie. CIDR

fromIP* - Starting IP address

maskbit* - Mask bit(1 to 127)

credentialName* - credential names as command separated

rediscoverExistingDevices* - rediscovering existing devices (true或false)

> Through CSV

apiKey* - 访问OpManager服务器的API密钥。

discoverType* - Format of discovery ie. CSV

credentialName* - selected credential name

netmask* - netMask

http://localhost:8060/api/json/discovery/discoverNetwork?apiKey=081c9ac51ba16ab061d5efee583dcd2f&toIP=192.168.25.16&fromIP=192.168.25.15&credentialName=Public&discoverType=Range&netmask=255.255.255.0&rediscoverExistingDevices=false

listCredentials

GET

Gives the list of credentials created in OpManager。

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/admin/listCredentials?apiKey=081c9ac51ba16ab061d5efee583dcd2f

listDownTimeSchedules

GET

Gives the list of downtime schedules created。

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/admin/listDownTimeSchedules?apiKey=83155f195334a19df5e58a8a33a6f804

RediscoverDevice

POST

Rediscovers a device

apiKey* - 访问OpManager服务器的API密钥。

name* - Name of the device。

snmpCredentialNames* - SNMP Credentials。

http://localhost:8060/api/json/device/RediscoverDevice?apiKey=081c9ac51ba16ab061d5efee583dcd2f&snmpCredentialNames=Public&name=opman-k8r2s-64-3.testdomain.com

reDiscoverInterfaces

POST

Rediscovers the interfaces

apiKey* - 访问OpManager服务器的API密钥。

deviceName* - Name of the device。

http://localhost:8060/api/json/discovery/reDiscoverInterfaces?deviceName=opman-k8r2s-64-3.testdomain.com&apiKey=081c9ac51ba16ab061d5efee583dcd2f

doSearch

GET

Search a device/interface

apiKey* - 访问OpManager服务器的API密钥。

type* - 设备类型 (DEVICE,INTERFACE, etc)。

searchString* - Search string (device name, interface name etc)。

http://localhost:8060/api/json/discovery/doSearch?apiKey=081c9ac51ba16ab061d5efee583dcd2f&type=DEVICE,INTERFACE&searchString=opman-k8r2s-64-3.testdomain.com

searchDevice

GET

Allows you to search for a device。

apiKey* - 访问OpManager服务器的API密钥。

deviceName* - Name of the device whose route has to be traced

http://localhost:8060/api/json/discovery/searchDevice?apiKey=081c9ac51ba16ab061d5efee583dcd2f&deviceName=opman-k8r2s-64-3.testdomain.com

Device Snapshot

addNotesToDevice

POST

Adds notes to a device。

apiKey* - 访问OpManager服务器的API密钥。

deviceName* - Name of the device to be added

FIELD_NAMES - List of fields to be added to the device. Eg.: Department=IT

http://localhost:8060/api/json/device/addNotesToDevice?apiKey=081c9ac51ba16ab061d5efee583dcd2f&deviceName=opman-k8r2s-64-3.testdomain.com&Cabinet=cubicle

addNTServiceMonitors

POST

添加Windows Services

apiKey* - 访问OpManager服务器的API密钥。

name* - Name of the device。

discoverFromDevice – true或false。

serviceNames – Service names in comma-separated format。

displayNames – 服务的显示名称s in comma-separted format。

assignedNTServices – Selected services (applicable only when 'discover from device' set to false or null)

http://localhost:8060/api/json/device/addNTServiceMonitors?apiKey=6d36ff8426cff396b81b248e5c458604&assignedNTServices=Windows Audio,Telnet,Net Logon,Messenger,IIS,ManageEngine Agent Helper,ManageEngine OpManager Agent&name=ctestlab-w2012.testdomain.com

associateServiceMonitor

POST

Associate Service monitors to the specified device

apiKey* - 访问OpManager服务器的API密钥。

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 in comma-separated format。

http://localhost:8060/api/json/admin/associateServiceMonitor?deviceName=ctestlab-w2012.testdomain.com&apiKey=6d36ff8426cff396b81b248e5c458604&serviceName=WebLogic(7001),Web(80),Telnet(23),SMTP(25)

getAssociatedMonitors

GET

Provides the list of monitors associated to a device。

apiKey* - 访问OpManager服务器的API密钥。

name - name of the device。

http://localhost:8060/api/json/device/getAssociatedMonitors?apiKey=081c9ac51ba16ab061d5efee583dcd2f&name=opman-k8r2s-64-3.testdomain.com

getAssociatedServiceMonitors

GET

Provides the service monitors associated with the specified device

apiKey* - 访问OpManager服务器的API密钥。

name* - Name of the device。

http://localhost:8060/api/json/device/getAssociatedServiceMonitors?apiKey=081c9ac51ba16ab061d5efee583dcd2f&name=opman-k8r2s-64-3.testdomain.com

getDeviceNotes

GET

Provides the details of notes such as floor no. and department name added to a device。

apiKey* - 访问OpManager服务器的API密钥。

name* - name of the device。

http://localhost:8060/api/json/device/getDeviceNotes?apiKey=081c9ac51ba16ab061d5efee583dcd2f&name=opman-k8r2s-64-3.testdomain.com

getDeviceSummary

GET

Provides the summary details of a device。

apiKey* - 访问OpManager服务器的API密钥。

name* - name of the device。

http://localhost:8060/api/json/device/getDeviceSummary?apiKey=081c9ac51ba16ab061d5efee583dcd2f&name=opman-k8r2s-64-3.testdomain.com

getNotificationProfiles

GET

Provides the list of notificiation associated profiles to a device。

apiKey* - 访问OpManager服务器的API密钥。

name* - name of the device。

http://localhost:8060/api/json/device/getNotificationProfiles?apiKey=83155f195334a19df5e58a8a33a6f804&name=opman-k8r2s-64-3.testdomain.com

getNTServiceMonitors

GET

Provides the WindowsNT Service monitors of specified device。

apiKey* - 访问OpManager服务器的API密钥。

name* - Name of the device。

discoverFromDevice – true或false or null。

http://localhost:8060/api/json/device/getNTServiceMonitors?apiKey=081c9ac51ba16ab061d5efee583dcd2f&name=opman-k8r2s-64-3.testdomain.com

getWorkFlows

GET

Provides the list of workflows associated to a device。

apiKey* - 访问OpManager服务器的API密钥。

name* - name of the device。

http://localhost:8060/api/json/device/getWorkFlows?apiKey=83155f195334a19df5e58a8a33a6f804&name=opman-k8r2s-64-3.testdomain.com

listActiveProcesses

POST

列出Active Processes

apiKey* - 访问OpManager服务器的API密钥。

deviceName* - Name of the device from which we want to get running processes list

protocol* - Protocol to be used (Either WMI/CLI/SNMP)

http://localhost:8060/api/json/admin/listActiveProcesses?apiKey=081c9ac51ba16ab061d5efee583dcd2f&deviceName=opman-k8r2s-64-2.testdomain.com&protocol=WMI

listActiveWindowsServices

POST

列出Active Windows Service Monitors

apiKey* - 访问OpManager服务器的API密钥。

deviceName* - Device Name

userName* - User Name

password* - Password

http://localhost:8060/api/json/admin/listActiveWindowsServices?apiKey=081c9ac51ba16ab061d5efee583dcd2f&userName=opman-k8r2s-64-3administrator&deviceName=opman-k8r2s-64-3&password=Vembu123

getAssociatedCredentials

GET

Obtains information on the credentials associated to a device

apiKey* - 访问OpManager服务器的API密钥。

name* – Name of the device whose credentials need to be fetched。

http://localhost:8060/api/json/device/getAssociatedCredentials?apiKey=081c9ac51ba16ab061d5efee583dcd2f&name=opman-k8r2s-64-3.testdomain.com

getPerfomanceMonitorDetails

GET

Obtains information of the performance monitors for a device

apiKey* - 访问OpManager服务器的API密钥。

policyName* - Name of the performance monitor。

graphName* - Graph name of the performance monitor。

name* - Name of the device。

checkNumeric* - true或false。

http://localhost:8060/api/json/device/getPerfomanceMonitorDetails?apiKey=6d36ff8426cff396b81b248e5c458604&policyName=WMI-CPUUtilization&graphName=WMI-CPUUtilization&name=172.18.100.130&checkNumeric=true

EditPerfomanceMonitor

POST

Enables editing the configuration of a performance monitor

TroubleThresholdType* - Type of threshold。

TroubleThresholdValue* - Trouble threshold value。

RearmValue* - Trouble threshold rearm value。

Interval – monitoring Interval in mins。

TimeAvg – Average time。

ThresholdEnabled – true或false。

GraphName – Name of the performance monitor graph。

WarningThresholdValue – Warning threshold value。

Type – threshold type。

OidType – OID Type。

TroubleMessage – Message to be populated on violating threshold。

TroubleThresholdTextValue – Trouble threshold value。

TroubleThresholdTextualType – Trouble threshold textual type (equals, contains etc)

Oid – OID of the performance monitor。

SendClear – True或false。

ClrMessage – Message to be displayed when the threshold is cleared。

Name – Device name。

CriticalThresholdTextValue – Critical threshold text value。

CriticalMessage – Message to be displayed on violating critical threshold。

CriticalThresholdType – Type of critical threshold (max, min)

RearmTextValue – Rearm value of critical threshold。

CriticalThresholdValue – Threshold value of the critical alarm。

WarningMessage – Warning message。

YaxisText – Text representing the values in y-axis。

WarningThresholdTextualType – warning threshold text type。

FailureThreshold – Failure threshold value。

Vendor – Vendor of the device。

CriticalThresholdTextualType – Critical threshold textual type。

ThresholdName – name of the threshold。

WarningThresholdType – Type of the warning threshold。

CheckNumeric – True或False。

FirstTime – True或False。

PolicyName – Name of the performance monitor。

InstanceName – Name of the monitor instance。

RearmTextualType – Rearm Textual type。

ClearThresholdType – Clear threshold type。

DisplayName – Displayname of the performance monitor。

WarningThresholdTextValue – Warning threshold text value。

http://localhost:8060/api/json/device/EditPerfomanceMonitor?troubleThresholdType=max&troubleThresholdValue=25&rearmValue=23&interval=5&timeAvg=&thresholdEnabled=true&graphName=WMI-CPUUtilization&warningThresholdValue=&type=multiple&oidType=&apiKey=6d36ff8426cff396b81b248e5c458604&troubleMessage=$MONITOR is $CURRENTVALUE%, threshold value for this monitor is $THRESHOLDVALUE%&troubleThresholdTextValue=25&troubleThresholdTextualType=Contains&oid=CPU Utilization&sendClear=true&clrMessage=$MONITOR is now back to normal, current value is $CURRENTVALUE%&name=172.18.100.130&criticalThresholdTextValue=&criticalMessage=$MONITOR is $CURRENTVALUE%, threshold value for this monitor is $THRESHOLDVALUE%&criticalThresholdType=max&rearmTextValue=23&criticalThresholdValue=&warningMessage=$MONITOR is $CURRENTVALUE%, threshold value for this monitor is $THRESHOLDVALUE%&yaxisText=Percentage&warningThresholdTextualType=Contains&failureThreshold=1&vendor=&criticalThresholdTextualType=Contains&thresholdName=&warningThresholdType=max&checkNumeric=true&firstTime=false&policyName=WMI-CPUUtilization&instanceName=&rearmTextualType=Not Contains&clearThresholdType=min&displayName=CPU Utilization&warningThresholdTextValue=

addPerfomanceMonitors

POST

Adds a new performance monitor for the given device

apiKey* - 访问OpManager服务器的API密钥。

name* - Name of the device。

selectedMonitors* - Name of the performance monitors。

http://localhost:8060/api/json/device/addPerfomanceMonitors?apiKey=6d36ff8426cff396b81b248e5c458604&name=172.18.100.130&selectedMonitors=693,692,203,204,205,304

getPerformanceMonitors

GET

Lists the performance monitors for the given device

apiKey* - 访问OpManager服务器的API密钥。

deviceName* - Name of the device。

category* - Name of the performance monitors。

type* - 设备类型

http://localhost:8060/api/json/device/getPerformanceMonitors?apiKey=081c9ac51ba16ab061d5efee583dcd2f&category=Server&deviceName=opman-k8r2s-64-3.testdomain.com&type=Windows 2008 R2

UpdateAdditionalFields

POST

Updates the additional fields present in the device snapshot page

apiKey* - 访问OpManager服务器的API密钥。

firstTime* - true或false。

interfacename* - Name of the interface。

type* - 设备类型。

UDF1* - Field value。

UDF2 – Filed value。

UDF3 – Field value。

UDF4 – Field value。

UDF5 – Field value。

http://localhost:8060/api/json/device/UpdateAdditionalFields?UDF1=qq22&UDF2=&firstTime=true&UDF5=&UDF3=&UDF4=&interfacename=IF-192.168.50.130-399&type=Interface&apiKey=6d36ff8426cff396b81b248e5c458604

UpdateDeviceDetails

POST

Updates device details

apiKey* - 访问OpManager服务器的API密钥。

vendor* - Vendor of the device。

name* - Device name。

monitoring* - Monitoring interval。

netmask* - Netmask address。

displayName* - Displayname of the device。

ipAddress* - Device IP address。

http://localhost:8060/api/json/device/UpdateDeviceDetails?apiKey=081c9ac51ba16ab061d5efee583dcd2f&vendor=Microsoft&name=opman-k8r2s-64-2.testdomain.com&Monitoring=60&Netmask=25.255.255.0&displayName=TEST11&ipAddress=172.18.155.78

GetCredentialsForDevice

GET

Obtains the credentials mapped to a device

apiKey* - 访问OpManager服务器的API密钥。

name* - Name of the device。

http://localhost:8060/api/json/device/GetCredentialsForDevice?apiKey=081c9ac51ba16ab061d5efee583dcd2f&name=opman-k8r2s-64-3.testdomain.com

GetMonitoringInterval

GET

Obtains the configured monitoring interval

apiKey* - 访问OpManager服务器的API密钥。

name* - Name of the device。

http://localhost:8060/api/json/device/GetMonitoringInterval?apiKey=081c9ac51ba16ab061d5efee583dcd2f&name=opman-k8r2s-64-3.testdomain.com

ConfigureMonitoringInterval

POST

Enables configuration of the monitoring interval

apiKey* - 访问OpManager服务器的API密钥。

pollenabled* - on or off。

protocol* - protocol of the device。

name* - Device name。

interval* - Monitoring interval。

http://localhost:8060/api/json/device/ConfigureMonitoringInterval?apiKey=081c9ac51ba16ab061d5efee583dcd2f&pollenabled=on&protocol=SNMP&name=opman-k8r2s-64-3.testdomain.com&interval=15

GetSuppressAlarmDetails

GET

Obtains the suppress alarm details of a device

apiKey* - 访问OpManager服务器的API密钥。

name* - Name of the device。

http://localhost:8060/api/json/device/GetSuppressAlarmDetails?apiKey=081c9ac51ba16ab061d5efee583dcd2f&name=opman-k8r2s-64-3.testdomain.com

ConfigureSuppressAlarm

POST

Configures suppress alarm for a device

apiKey* - 访问OpManager服务器的API密钥。

name* - Name of the device。

suppressInterval* - Alarm suppress interval。

http://localhost:8060/api/json/device/ConfigureSuppressAlarm?apiKey=081c9ac51ba16ab061d5efee583dcd2f&name=opman-k8r2s-64-3.testdomain.com&suppressInterval=3600000

setManaged

POST

Enables the device to be in managed state

apiKey* - 访问OpManager服务器的API密钥。

name* - Name of the device。

manage* - Set device in managed statue (true或false)。

http://localhost:8060/api/json/device/setManaged?apiKey=081c9ac51ba16ab061d5efee583dcd2f&manage=false&name=opman-k8r2s-64-3.testdomain.com

deletePerfomanceMonitors

POST

Deletes the performance monitor from the given device

apiKey* - 访问OpManager服务器的API密钥。

name* – Name of the device whose credentials need to be fetched。

policyName* - Name of the performance monitor。

http://localhost:8060/api/json/device/deletePerfomanceMonitors?apiKey=081c9ac51ba16ab061d5efee583dcd2f&policyName=Win-CPUUtilization&name=opman-k8r2s-64-2.testdomain.com

getInterfaceGraphs

GET

Show graph values for a interface

apiKey* - 访问OpManager服务器的API密钥。

interfaceName* - Name of the interface。

graphName* - Graph name of the performance monitor。

http://localhost:8060/api/json/device/getInterfaceGraphs?interfaceName=IF-192.168.49.106-329&graphName=rxutilization&apiKey=6d36ff8426cff396b81b248e5c458604

fetchMonitorsList

POST

Fetches all configured monitors of a device

apiKey* - 访问OpManager服务器的API密钥。

username* - Username。

category* - Device category。

deviceList* - List of devices。

http://localhost:8060/api/json/device/fetchMonitorsList?apiKey=081c9ac51ba16ab061d5efee583dcd2f&username=admin&category=Server&deviceList=opman-k8r2s-64-3.testdomain.com

getInterfaceUtilization

GET

获取utilization of the given interfaces

apiKey* - 访问OpManager服务器的API密钥。

period* - Period for which graph is required. (fourhours, twohours etc)

interfaceList* - List of interfaces。

http://localhost:8060/api/json/device/getInterfaceUtilization?interfaceList=IF-192.168.49.106-335,IF-192.168.49.101-497,IF-192.168.50.7-343,IF-192.168.50.7-338,IF-192.168.50.7-339,IF-192.168.49.101-503,IF-192.168.49.101-504,IF-192.168.49.101-495,IF-192.168.49.101-490,IF-192.168.49.101-494,IF-192.168.49.101-513,IF-192.168.49.101-502,IF-192.168.49.101-512,IF-192.168.49.101-492,IF-192.168.49.101-505,IF-192.168.49.101-498,IF-192.168.49.101-514,IF-cisco2081.testdomain.com-672,IF-192.168.50.7-337,IF-cisco2081.testdomain.com-563,IF-cisco2081.testdomain.com-667,IF-cisco2081.testdomain.com-670,IF-192.168.49.101-549,IF-192.168.49.101-547,IF-192.168.49.101-556,IF-192.168.49.101-558,IF-192.168.49.101-516,IF-192.168.49.101-511,IF-192.168.49.101-520,IF-192.168.49.101-519,IF-192.168.49.101-496,IF-192.168.49.106-330,IF-192.168.49.101-552,IF-192.168.49.101-515,IF-192.168.49.101-550,IF-cisco2081.testdomain.com-995,IF-192.168.49.106-331,IF-192.168.49.146-324,IF-192.168.49.146-322,IF-192.168.49.146-323,IF-192.168.49.106-329&period=twfourhours&apiKey=6d36ff8426cff396b81b248e5c458604

getGraphData

GET

Fetches graph value for the given monitors

apiKey* - 访问OpManager服务器的API密钥。

index* - Name of the performance monitor。

name* - Name of the device。

policyName* - Name of the performance monitor。

http://localhost:8060/api/json/device/getGraphData?index=WMI-CPUUtilization&policyName=WMI-CPUUtilization&name=172.18.99.60&apiKey=6d36ff8426cff396b81b248e5c458604

getGraphNames

GET

Obtains the name of all available graphs for the given device

apiKey* - 访问OpManager服务器的API密钥。

name* - Name of the device。

http://localhost:8060/api/json/device/getGraphNames?apiKey=081c9ac51ba16ab061d5efee583dcd2f&name=opman-k8r2s-64-3.testdomain.com

associateServiceMonitor

POST

Associate service monitor to the device。

apiKey* - 访问OpManager服务器的API密钥。

deviceName* - 设备类型。

serviceName* - Name of the service monitors。

http://localhost:8060/api/json/admin/associateServiceMonitor?apiKey=6d36ff8426cff396b81b248e5c458604&deviceName=msp-k8r2e-64-1.testdomain.com&serviceName=SMTP(25),Web(80),DNS(53),LDAP(389),WebLogic(7001),Telnet(23)

getUrlDetails

GET

Fetches URL monitor details

apiKey* - 访问OpManager服务器的API密钥。

urlName* - URL Name。

deviceName* - Name of the device。

http://localhost:8060/api/json/admin/getUrlDetails?apiKey=6d36ff8426cff396b81b248e5c458604&deviceName=msp-k8r2e-64-1.testdomain.com&urlName=testurl

EventLog

addEventLogRules

POST

添加an Event log rule

apiKey* - 访问OpManager服务器的API密钥。

ruleName* - Event log rule name to be added。

logFileName* – Event log filename。

status* – log status。

failureThreshold* – Failure threshold。

thresholdInterval* – threshold interval。

eventID – Event ID。

category – event category。

source – Event source。

userName – User name。

message – event message。

eventType – event type。

http://localhost:8060/api/json/admin/addEventLogRules?apiKey=081c9ac51ba16ab061d5efee583dcd2f&status=1&logFileName=Application&ruleName=testevent1&thresholdInterval=1&failureThreshold=1

deleteEventLogRules

POST

Enables deletion of Eventlog rule。

apiKey* - 访问OpManager服务器的API密钥。

rulename* - Event log rule name to be added。

http://localhost:8060/api/json/admin/deleteEventLogRules?apiKey=081c9ac51ba16ab061d5efee583dcd2f&rulename=testevent1

showEventLogRules

GET

Displays the available event log rules

apiKey* - 访问OpManager服务器的API密钥。

showEventLogRules* - on or off。

http://localhost:8060/api/json/admin/showEventLogRules?apiKey=081c9ac51ba16ab061d5efee583dcd2f

updateEventLogRules

POST

Updates the Eventlog rule。

http://localhost:8060/api/json/admin/updateEventLogRules?apiKey=081c9ac51ba16ab061d5efee583dcd2f&status=1&logFileName=Application&ruleName=testevent1&thresholdInterval=1&failureThreshold=1

viewEventLogRules

GET

Provides information on the event log rule

apiKey* - 访问OpManager服务器的API密钥。

ruleName* - Event log rule name to be added。

logFileName* – Event log file name。

http://localhost:8060/api/json/admin/viewEventLogRules?apiKey=081c9ac51ba16ab061d5efee583dcd2f&logFileName=Application&ruleName=testevent1

Interface discovery

discoverInterface

POST

Discovers an interface。

apiKey* - 访问OpManager服务器的API密钥。

devicesList* - DeviceNames(moname) as comma separated

intftypes* - Intf types as numeric numbers(E.g: Ethernet=6)

adminStates* - Interface AdminStatus as numeric numbers(UP=1, DOWN=2)

operStates* - Interface OperStatus as numeric numbers(UP=1, DOWN=2)

http://localhost:8060/api/json/discovery/discoverInterface?apiKey=081c9ac51ba16ab061d5efee583dcd2f&adminStates=1&operStates=1&devicesList=opman-k8r2s-64-3.testdomain.com

getInterfaces

GET

Provides the list of interfaces in a device。

apiKey* - 访问OpManager服务器的API密钥。

name* - name of the device。

http://localhost:8060/api/json/device/getInterfaces?apiKey=081c9ac51ba16ab061d5efee583dcd2f&name=opman-k8r2s-64-3.testdomain.com

getInterfaceSummary

GET

Provides the summary details of an interface。

apiKey* - 访问OpManager服务器的API密钥。

interfaceName - name of the interface

http://localhost:8060/api/json/device/getInterfaceSummary?apiKey=83155f195334a19df5e58a8a33a6f804&interfaceName=IF-opman-k8r2s-64-3.testdomain.com-4505

Inventory

getAllUrlMonitorDetails

GET

列出OpManager创建的所有the URL监视器 created。

apiKey* - 访问OpManager服务器的API密钥.

http://localhost:8060/api/json/discovery/getAllUrlMonitorDetails?apiKey=83155f195334a19df5e58a8a33a6f804

getInterfaceTypes

GET

Provides the type of interface. eg: serial, ethernet。

apiKey* - 访问OpManager服务器的API密钥.

http://localhost:8060/api/json/device/getInterfaceTypes?apiKey=081c9ac51ba16ab061d5efee583dcd2f

getProbeURL

GET

Provides the URL of the probe。

apiKey* - 访问OpManager服务器的API密钥。

name - name of the device。

http://localhost/api/json/device/addNotesToDevice?apiKey=ac130763a309fcb1613e0b8a551950a2&name=localhost.testdomain.com

listVirtualDevices

GET

列出OpManager创建的所有the available virtual devices

apiKey* - 访问OpManager服务器的API密钥。

virtualDeviceType* - Type of the virtual device.

http://localhost:8060/api/json/device/listVirtualDevices?virtualDeviceType=VM&apiKey=1d626117b2ac31145ce6bca49bb0458b

fetchInterfacesList

GET

Fetches all interfaces of the given device and category

apiKey* - 访问OpManager服务器的API密钥。

username* – username。

category* – Device category。

deviceList* – Device name。

http://localhost:8060/api/json/device/fetchInterfacesList?apiKey=081c9ac51ba16ab061d5efee583dcd2f&username=admin&category=Server&deviceList=opman-k8r2s-64-3.testdomain.com

fetchDevicesList

GET

Fetches all devices available in the given category

apiKey* - 访问OpManager服务器的API密钥。

username* – username。

category* – Device category。

http://localhost:8060/api/json/device/fetchDevicesList?apiKey=081c9ac51ba16ab061d5efee583dcd2f&username=admin&category=Server

listDevices

GET

列出OpManager创建的所有the devices added in OpManager。

apiKey* - 访问OpManager服务器的API密钥。

deviceName - Name of the device that has to be filtered

type - The device type which has to be filtered. Eg.Windows 7

Category - The category to which the device belongs to. Eg. Router

http://localhost:8060/api/json/device/listDevices?apiKey=081c9ac51ba16ab061d5efee583dcd2f&Category=Server&deviceName=opman-k8r2s-64-3.testdomain.com&type=Windows 2008 R2

listInterfaces

GET

列出OpManager创建的所有the interfaces in OpManager。

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/device/listInterfaces?apiKey=83155f195334a19df5e58a8a33a6f804

getDevicePackageList

GET

Lists device package

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/device/getDevicePackageList?apiKey=081c9ac51ba16ab061d5efee583dcd2f

getCategoryList

GET

列出OpManager创建的所有the available device categories

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/device/getCategoryList?apiKey=081c9ac51ba16ab061d5efee583dcd2f

getVendorList

GET

列出OpManager创建的所有the vendors

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/device/getVendorList?apiKey=081c9ac51ba16ab061d5efee583dcd2f

Layer2 discovery

addLayer2Map

POST

Adds a Layer2 devices Map

apiKey* - 访问OpManager服务器的API密钥。

mapName* - Name of the Map

seedDevice* - Seed Router Or L3 Switch Address

startAddr* - Start IpAddress of the network

endAddr* - End IpAddress of the network

subnetMask* - Subnet Mask for the network

credentialName* - Array of credentials existing in Opmanager in comma separated format

scheduleInterval* - Scheduling Interval (Number Of Days) default 5 days

discoverNow* - true/false. if true, Add the Layer2 Configuration and discover it. If false, add only the Layer2 Configuration and discover after the schedule period。

http://localhost:8060/api/json/discovery/addLayer2Map?apiKey=081c9ac51ba16ab061d5efee583dcd2f&credentialName=Public&seedDevice=192.168.49.1&startAddr=192.168.49.1&mapName=Testmap&endAddr=192.168.50.130&discoverNow=true&scheduleInterval=5

deleteLayer2Map

POST

Allows to delete Layer2 map。

apiKey* - 访问OpManager服务器的API密钥。

mapName* - Name Of the Map to be deleted

http://localhost:8060/api/json/discovery/deleteLayer2Map?apiKey=081c9ac51ba16ab061d5efee583dcd2f&mapName=Testmap

discoverLayer2Devices

POST

Discovers Layer2 devices

apiKey* - 访问OpManager服务器的API密钥。

deviceNames* - Array Of Devices in comma-separated format

http://localhost/api/json/discovery/discoverLayer2Devices?apiKey=ac130763a309fcb1613e0b8a551950a2&deviceNames=192.168.49.1,192.168.50.130

discoverLayer2Map

POST

Discovers Layer2 Map

apiKey* - 访问OpManager服务器的API密钥。

mapName* - Name Of the Map to be discovered/updated

http://localhost:8060/api/json/discovery/discoverLayer2Map?apiKey=081c9ac51ba16ab061d5efee583dcd2f&mapName=TestMap

getDiscoveredLayer2Map

GET

Allows you to view the discovered Layer2 Map

apiKey* - 访问OpManager服务器的API密钥。

mapName* - Name Of the Map to be shown

http://localhost:8060/api/json/discovery/getDiscoveredLayer2Map?apiKey=081c9ac51ba16ab061d5efee583dcd2f&mapName=TestMap

getLayer2ScanDetails

GET

Obtains information regarding the Layer 2 scans ran up-to-date

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/maps/getLayer2ScanDetails?apiKey=5022357be4231edff71ed25cf960457a

getLayer2Maps

GET

列出OpManager创建的所有the Layer2 Maps available in Opmanager

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/maps/getLayer2Maps?apiKey=081c9ac51ba16ab061d5efee583dcd2f

邮件服务器 Settings

ConfigureMailServerSettings

POST

Allows you to configure the 邮件服务器 settings。

apiKey* - 访问OpManager服务器的API密钥。

mailServerName* - name of the mail-server。

mailServerPort* -端口号 of the 邮件服务器。

toEmailId* - Email id to whom the notification to be sent。

timeOut* - Connection timeout in seconds。

secureMode* - Enable SSL (on or off)。

keyPassword - ssl key password。

isSecondary - secondary mails server(TRUE或FALSE)。

authenticationRequired - ON or OFF。

mailUserName* - authentication username。

mailPassword* - authentication password

http://localhost:8060/api/json/admin/ConfigureMailServerSettings?apiKey=081c9ac51ba16ab061d5efee583dcd2f&mailServerPort=463&mailPassword=mspcenter&secureMode=off&keyPassword=NULL&isSecondary=true&timeOut=5&authenticationRequired=off&toEmailId=msplite@gmail.com&mailServerName=smtp.gmail.com&mailUserName=msplite@gmail.com

GetMailServerSettings

GET

Provides the details of 邮件服务器 settings。

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/admin/GetMailServerSettings?apiKey=081c9ac51ba16ab061d5efee583dcd2f

getMailVariables

GET

获取send mail parameters

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/admin/getMailVariables?apiKey=081c9ac51ba16ab061d5efee583dcd2f

Maps

addBusinessView

POST

Adds a new 业务视图。

apiKey* - 访问OpManager服务器的API密钥。

bvName* - Name of the 业务视图。

http://localhost:8060/api/json/discovery/addBusinessView?apiKey=081c9ac51ba16ab061d5efee583dcd2f&bvName=test

addDeviceToBV

POST

Adds devices to a 业务视图 that is already created。

apiKey* - 访问OpManager服务器的API密钥。

deviceName* - Name of the device to be added in 业务视图. Enter multiple device names separated by a comma。

bvName* - Name of the 业务视图。

http://localhost:8060/api/json/discovery/addDeviceToBV?apiKey=081c9ac51ba16ab061d5efee583dcd2f&deviceName=opman-k8r2s-64-3.testdomain.com&bvName=test

getBusinessDetailsView

GET

列出OpManager创建的所有the devices available in a 业务视图。

apiKey* - 访问OpManager服务器的API密钥。

bvName* - Name of the 业务视图。

viewLength - Length of the data. If not provided, default length 250 will be used。

startPoint - data from startPoint Example 1 means, fetch data from 1 - optional parameter

http://localhost:8060/api/json/businessview/getBusinessDetailsView?apiKey=081c9ac51ba16ab061d5efee583dcd2f&viewLength=250&startPoint=1&bvName=test

getBusinessView

GET

列出OpManager创建的所有the 业务视图s created。

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/businessview/getBusinessView?apiKey=081c9ac51ba16ab061d5efee583dcd2f

getFloorDetails

GET

Provides the details of floor. eg, floor size, tile size。

apiKey* - 访问OpManager服务器的API密钥。

floorId* - Floor ID obtained from listFloors

http://localhost:8060/api/json/maps/getFloorDetails?apiKey=83155f195334a19df5e58a8a33a6f804&floorId=1

getInfrastructureView

GET

Provides the details of a particular infrastructure type. eg.: servers。

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/discovery/getInfrastructureView?apiKey=081c9ac51ba16ab061d5efee583dcd2f

listFloors

GET

列出OpManager创建的所有the floors created。

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/maps/listFloors?apiKey=1d626117b2ac31145ce6bca49bb0458b

listRacks

GET

列出OpManager创建的所有the racks created。

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/maps/listRacks?apiKey=83155f195334a19df5e58a8a33a6f804

RemoveBVFromUser

GET

Removes the 业务视图 associated to an user

apiKey* - 访问OpManager服务器的API密钥。

userName* - Username。

domainName* - Domain name。

bvName* - 业务视图 name.

http://localhost:8060/api/json/businessview/RemoveBVFromUser?apiKey=081c9ac51ba16ab061d5efee583dcd2f&userName=rejoe@testdomain.com&domainName=ZOHOCORP&bvName=test

AssociateBVToUser

GET

Associates the 业务视图 to an user

apiKey* - 访问OpManager服务器的API密钥。

userName* - Username。

domainName* - Domain name。

bvName* - 业务视图 name.

http://localhost:8060/api/json/businessview/AssociateBVToUser&userName=rejoe@testdomain.com&apiKey=081c9ac51ba16ab061d5efee583dcd2f&domainName=ZOHOCORP&bvName=test

getUsersAssociatedToBV

GET

Displays all the users associated to the given 业务视图

apiKey* - 访问OpManager服务器的API密钥。

BvName* - 业务视图 name.

http://localhost:8060/api/json/businessview/getUsersAssociatedToBV?apiKey=83155f195334a19df5e58a8a33a6f804&bvName=test

deleteMapCoordinates

POST

Delete device map coordinates

apiKey* - 访问OpManager服务器的API密钥。

deviceName* – Name of the device to be deleted from the map。

http://localhost:8060/api/json/device/deleteMapCoordinates&deviceName=opman-k8r2s-64-3.testdomain.com&apiKey=081c9ac51ba16ab061d5efee583dcd2f

updateMapCoordinates

POST

Updates device map coordinates

apiKey* - 访问OpManager服务器的API密钥。

deviceName* – Name of the device to be deleted from the map。

mapCoordinates* - Coordinates of the device in the map。

http://localhost:8060/api/json/device/updateMapCoordinates?apiKey=081c9ac51ba16ab061d5efee583dcd2f&deviceName=opman-k8r2s-64-3.testdomain.com&mapCoordinates=0,244

getBVDetails

GET

Fetches information of the given BusinessView

apiKey* - 访问OpManager服务器的API密钥。

BvName* - 业务视图 name。

viewId* - 业务视图 Id.

http://localhost:8060/api/json/businessview/getBVDetails?apiKey=081c9ac51ba16ab061d5efee583dcd2f&viewId=1&bvName=test

Monitoring

addWindowsServiceMonitor

POST

添加Windows Service Monitors

apiKey* - 访问OpManager服务器的API密钥。

serviceName* - Actual Service Name。

serviceDisplayName* - 服务的显示名称。

failureThreshold - 重试次数 used to generate service down alarm。

actionType - Either 0/1/2, 0 - No Action, 1 - Restart the service, 2 - Restart the server

http://localhost:8060/api/json/admin/addWindowsServiceMonitor?apiKey=081c9ac51ba16ab061d5efee583dcd2f&serviceName=idsvc&serviceDisplayName=Windows+CardSpace&actionType=0&failureThreshold=1

deleteDownTimeSchedules

POST

Deletes a particular downtime scheduler。

apiKey* - 访问OpManager服务器的API密钥。

scheduleId* – ID of the schedule

http://localhost:8060/api/json/admin/deleteDownTimeSchedules?apiKey=83155f195334a19df5e58a8a33a6f804&scheduleId=1

getADDetails

GET

Provides the details of Active-Directory device

apiKey* - 访问OpManager服务器的API密钥。

name - name of the device。

http://localhost:8060/api/json/device/getADDetails?apiKey=83155f195334a19df5e58a8a33a6f804&name=opman-hyperv.opmanhv.com

getAllVoipMetrics

GET

列出OpManager创建的所有the VoIP monitors created。

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/discovery/getAllVoipMetrics?apiKey=83155f195334a19df5e58a8a33a6f804

getAllWanMetrics

GET

列出OpManager创建的所有the WAN monitors created。

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/discovery/getAllWanMetrics?apiKey=83155f195334a19df5e58a8a33a6f804

getAvailabiltyGraphData

GET

Provides the data used to calculate the availability graph。

apiKey* - 访问OpManager服务器的API密钥。

period* - period for which availability graph is required。

Parameters:

LAST_12_HOURS
LAST_24_HOURS
TODAY
YESTERDAY
LAST_7_DAYS
LAST_30_DAYS
THIS_WEEK
LAST_WEEK
THIS_MONTH
LAST_MONTH

deviceName* - name of the device OR elementID* - MOID of the Interface。

http://localhost:8060/api/json/device/getAvailabiltyGraphData?apiKey=081c9ac51ba16ab061d5efee583dcd2f&deviceName=opman-k8r2s-64-3.testdomain.com&period=LAST_12_HOURS

getDownDevices

GET

Provides the details of devices that are down。

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/discovery/getDownDevices?apiKey=83155f195334a19df5e58a8a33a6f804

getExchangeDetails

GET

Provides the details of Exchange Server device

apiKey* - 访问OpManager服务器的API密钥。

name - name of the device。

http://localhost:8060/api/json/device/getExchangeDetails?apiKey=83155f195334a19df5e58a8a33a6f804&name=msp-k8r2e-64-1.testdomain.com

getInterfaceMonitors

GET

Provides the list of monitors associated to an interface。

apiKey* - 访问OpManager服务器的API密钥。

interfaceName - name of the interface。

http://localhost:8060/api/json/device/getInterfaceMonitors?apiKey=83155f195334a19df5e58a8a33a6f804&interfaceName=IF-opman-k8r2s-64-3.testdomain.com-4505

getInterfaceNotes

GET

Provides the details of the notes added to an interface。

apiKey* - 访问OpManager服务器的API密钥。

interfaceName - name of the interface

http://localhost:8060/api/json/device/getInterfaceNotes?apiKey=83155f195334a19df5e58a8a33a6f804&interfaceName=IF-opman-k8r2s-64-3.testdomain.com-4505

getMSSQLDetails

GET

Provides the details of MSSQL Server device

apiKey* - 访问OpManager服务器的API密钥。

name - name of the device。

http://localhost:8060/api/json/device/getMSSQLDetails?apiKey=83155f195334a19df5e58a8a33a6f804&name=opman-k8r2s-64-2.testdomain.com

getPingResponse

GET

Pings a device and provides the response。

apiKey* - 访问OpManager服务器的API密钥。

deviceName* - Name of the device which has to be pinged。

http://localhost:8060/api/json/device/getPingResponse?apiKey=081c9ac51ba16ab061d5efee583dcd2f&deviceName=opman-k8r2s-64-3.testdomain.com

getPollsPerSec

GET

Provides the current polls per second value of OpManager。

apiKey* - 访问OpManager服务器的API密钥。

graphType* – Type of graph required ie. Pollpersec。

fromTime* – date string in the format: yyyy-MM-dd HH:mm:ss

toTime* - date string in the format: yyyy-MM-dd HH:mm:ss

http://localhost:8060/api/json/diagnostics/getPollsPerSec?apiKey=081c9ac51ba16ab061d5efee583dcd2f&fromTime=2013-12-21 00:01:15&graphType=Pollpersec&toTime=2013-12-21 23:59:15

getTraceResponse

GET

Allows you to get the traceroute to a device。

apiKey* - 访问OpManager服务器的API密钥。

deviceName* - Name of the device which has to be pinged。

http://localhost:8060/api/json/device/getTraceResponse?apiKey=081c9ac51ba16ab061d5efee583dcd2f&deviceName=opman-k8r2s-64-3.testdomain.com

listEventLogRules

GET

列出OpManager创建的所有the event log rules created。

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/admin/listEventLogRules?apiKey=081c9ac51ba16ab061d5efee583dcd2f

listPerformanceMonitors

GET

列出OpManager创建的所有the performance monitors added。

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/admin/listPerformanceMonitors?apiKey=081c9ac51ba16ab061d5efee583dcd2f

listScriptMonitors

GET

列出OpManager创建的所有the script monitors created。

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/admin/listScriptMonitors?apiKey=081c9ac51ba16ab061d5efee583dcd2f

listServiceMonitors

GET

列出OpManager创建的所有the service monitors created。

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/admin/listServiceMonitors?apiKey=081c9ac51ba16ab061d5efee583dcd2f

listSysLogRules

GET

列出OpManager创建的所有the syslog规则s created。

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/admin/listSysLogRules?apiKey=081c9ac51ba16ab061d5efee583dcd2f

listTrapProcessors

GET

列出OpManager创建的所有the trap processor created。

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/admin/listTrapProcessors?apiKey=081c9ac51ba16ab061d5efee583dcd2f

listURLMonitors

GET

列出OpManager创建的所有teh URL监视器 created。

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/admin/listURLMonitors?apiKey=5070623c57db770f93ca914dc7b598f8

listWindowsServiceMonitors

GET

列出OpManager创建的所有the Windows service monitors created。

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/admin/listWindowsServiceMonitors?apiKey=081c9ac51ba16ab061d5efee583dcd2f

listStatusPollDetails

GET

列出status poll details of particular interface type。

apiKey* - 访问OpManager服务器的API密钥。

typeName* - 设备类型/interface

http://localhost:8060/api/json/admin/listStatusPollDetails?apiKey=081c9ac51ba16ab061d5efee583dcd2f&typeName=Ethernet

TestMonitor

GET

Test Monitor action

apiKey* - 访问OpManager服务器的API密钥。

name* - Name of the device。

policyName* - Policy name of the monitor。

graphName - Graph name。

instanceName – Instance name。

http://localhost:8060/api/json/device/TestMonitor?apiKey=081c9ac51ba16ab061d5efee583dcd2f&policyName=Win-CPUUtilization&graphName=Win-CPUUtilization&name=opman-k8r2s-64-3.testdomain.com

updateDeviceStatus

GET

Pings the device and upates the correct status of a device。

apiKey* - 访问OpManager服务器的API密钥。

name* - name of the device。

http://localhost:8060/api/json/device/updateDeviceStatus?apiKey=081c9ac51ba16ab061d5efee583dcd2f&name=opman-k8r2s-64-3.testdomain.com

Proxy Server Settings

ConfigureProxyServerSettings

POST

Allows to configure the proxy server settings。

apiKey* - 访问OpManager服务器的API密钥。

domainName - Name of the domain that has to be added。

Host* - Proxy Server name。

Port* - Port at which the Proxy server is running。

UserName* - proxy user name。

Password* - proxy password。

noproxyhostlist – no proxy list

http://localhost:8060/api/json/admin/ConfigureProxyServerSettings?apiKey=081c9ac51ba16ab061d5efee583dcd2f&Username=rejoe-0162&domainName=csez.testdomain.com&Host=192.168.5.100&noproxyhostlist=NULL&Password=o&Port=80

GetProxyServerSettings

GET

Provides the details of proxy server settings。

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/admin/GetProxyServerSettings?apiKey=081c9ac51ba16ab061d5efee583dcd2f

UpdateProxyServerSettings

POST

Allows to update the existing proxy server settings。

apiKey* - 访问OpManager服务器的API密钥。

enableProxy* – TRUE或FALSE

http://localhost:8060/api/json/admin/UpdateProxyServerSettings?apiKey=081c9ac51ba16ab061d5efee583dcd2f&enableProxy=FALSE

短信服务器 Settings

configureSMSServerSettings

POST

Allows to configure the 短信服务器 settings。

apiKey* - 访问OpManager服务器的API密钥。

portno* -
mobileno* - Mobile number from which the SMS to be sent

http://localhost:8060/api/json/admin/configureSMSServerSettings?apiKey=081c9ac51ba16ab061d5efee583dcd2f&mobileno=9840833757&portno=COM21

GetSMSServerSettings

GET

Provides the details of 短信服务器 settings。

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/admin/GetSMSServerSettings?apiKey=081c9ac51ba16ab061d5efee583dcd2f

SysLogs

deleteSysLogForwarder

POST

Delete SysLog Forwarder

apiKey* - 访问OpManager服务器的API密钥。

destHost* - 目标主机。

destPort* -目标端口。。

http://localhost:8060/api/json/admin/deleteSysLogForwarder?apiKey=081c9ac51ba16ab061d5efee583dcd2f&destHost=opman-k8r2s-64-2&destPort=516

deleteSysLogRule

POST

Delete SysLog规则

apiKey* - 访问OpManager服务器的API密钥。

ruleName* - 规则名称

http://localhost:8060/api/json/admin/deleteSysLogRule?apiKey=081c9ac51ba16ab061d5efee583dcd2f&ruleName=test11

getSysLogAlertSeverityMap

GET

列出SysLog AlertSeverityMap

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/admin/getSysLogAlertSeverityMap?apiKey=081c9ac51ba16ab061d5efee583dcd2f

getSysLogFacilityMap

GET

列出SysLog FacilitiesMap

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/admin/getSysLogFacilityMap?apiKey=081c9ac51ba16ab061d5efee583dcd2f

getSysLogForwarders

GET

列出SysLog Forwarders

apiKey* - 访问OpManager服务器的API密钥。

ruleName* - Sys Log Rule Name。

http://localhost:8060/api/json/admin/getSysLogForwarders?apiKey=081c9ac51ba16ab061d5efee583dcd2f

getSysLogPort

GET

获取SysLog Ports

apiKey* - 访问OpManager服务器的API密钥。

portNumber*-端口号s（使用英文逗号隔开）

http://localhost:8060/api/json/admin/getSysLogPort?apiKey=081c9ac51ba16ab061d5efee583dcd2f

getSysLogRuleContent

GET

SysLog规则 Info

apiKey* - 访问OpManager服务器的API密钥。

ruleName* - Sys Log Rule Name

http://localhost:8060/api/json/admin/getSysLogRuleContent?apiKey=081c9ac51ba16ab061d5efee583dcd2f&ruleName=Failed logins

getSysLogSeverityMap

GET

列出SysLog严重性Map

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/admin/getSysLogSeverityMap?apiKey=081c9ac51ba16ab061d5efee583dcd2f

isSysLogRuleExists

GET

Is SysLog规则 Exists

apiKey* - 访问OpManager服务器的API密钥。

ruleName* - Sys Log Rule Name。

http://localhost:8060/api/json/admin/isSysLogRuleExists?apiKey=081c9ac51ba16ab061d5efee583dcd2f&ruleName=Failed logins

startSysLogForwarder

POST

Start SysLog Forwarder

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/admin/startSysLogForwarder?apiKey=081c9ac51ba16ab061d5efee583dcd2f

stopSysLogForwarder

POST

Stop SysLog Forwarder

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/admin/stopSysLogForwarder?apiKey=081c9ac51ba16ab061d5efee583dcd2f

updateSysLogForwarder

POST

Update SysLog Forwarder

apiKey* - 访问OpManager服务器的API密钥。

destHost* - Previous 目标主机。

destPort* - Previous目标端口。。

newDestHost* - New 目标主机。

newDestPort* - New目标端口。。

http://localhost:8060/api/json/admin/updateSysLogForwarder?apiKey=081c9ac51ba16ab061d5efee583dcd2f&newDestPort=516&destHost=opman-k8r2s-64-3&destPort=515&newDestHost=opman-k8r2s-64-2

updateSysLogRule

POST

Update SysLog规则

apiKey* - 访问OpManager服务器的API密钥。

ruleName* - 规则名称

facilityName - SysLog设施

severityList - SysLog严重性（使用英文逗号隔开）

alertSeverity - OpManager告警严重性

alarmMessage - OpManager告警信息

matchString - 收到的Syslog信息中配置的字符串

consecutiveTime - 重试次数

timeInterval - 时间间隔
（如果选择了rearmFacilityName，那么也应该选择rearmSeverityList）

rearmFacilityName - 重置syslog的设施名称

rearmSeverityList : 重置syslog的严重性

rearmMatchString : 重置syslog匹配的字符串

http://localhost:8060/api/json/admin/updateSysLogRule?apiKey=081c9ac51ba16ab061d5efee583dcd2f&description=auth alert rule&alertSeverity=2&matchString=matchstring&facilityName=auth&ruleName=test11&alarmMessage=test&severityList=alert

Templates

addProcessTemplate

POST

添加Process Template

apiKey* - 访问OpManager服务器的API密钥。

processName* - Name of the process

path* - Process path

argument* - Process argument

protocol* - protocol to be used

displayName - DisplayName for the process

matchPath - boolean(true/false). If it is true - compare process path while polling process

matchArgs - boolean(true/false). If it is true - compare process argument while polling process

http://localhost:8060/api/json/admin/addProcessTemplate?apiKey=1d626117b2ac31145ce6bca49bb0458b&argument=NONE&protocol=SNMP&matchPath=true&path=C:Progra~2Site24x7WinAgentMonitorinn&processName=MonitoringAgent.exe&displayName=Site24x7MonitoringAgent&matchArgs=false

addVendor

POST

添加new vendor name。

apiKey* - api key。

vendor* - Vendor name of the device。

http://localhost:8060/api/json/admin/addVendor?apiKey=081c9ac51ba16ab061d5efee583dcd2f&vendor=testvendor3

associateDeviceTemplate

POST

Associate templates to the device。

apiKey* - api key。

selectedDevices* - device name (comma-separated)。

typeName* - Device type。

http://localhost:8060/api/json/admin/associateDeviceTemplate?apiKey=1d626117b2ac31145ce6bca49bb0458b&typeName=Windows 2008 R2&selectedDevices=opman-k8r2s-64-2.testdomain.com

associateProcessTemplate

POST

Associate Process Template

apiKey* - 访问OpManager服务器的API密钥。

templateName* - Process template name to be associated. For Bulk template association, give template names by comma separated

deviceName* - Device name to which the template has to be applied. For Bulk template association, give template names by comma separated

protocol* - Protocol to be used

http://localhost:8060/api/json/admin/associateProcessTemplate?apiKey=081c9ac51ba16ab061d5efee583dcd2f&deviceName=opman-k8r2s-64-3.testdomain.com&protocol=WMI&templateName=MSSQL

deleteDeviceTemplate

POST

Enables deletion of Device Templates。

apiKey* - 访问OpManager服务器的API密钥。

typeName* - Template type name。

http://localhost:8060/api/json/admin/deleteDeviceTemplate?apiKey=081c9ac51ba16ab061d5efee583dcd2f&typeName=3com 3500G-EI

deleteProcessTemplate

POST

Delete Process Template

apiKey* - 访问OpManager服务器的API密钥。

templateName* - Process Template name to be deleted。

protocol* - protocol used to discover the process。

http://localhost:8060/api/json/admin/deleteProcessTemplate?apiKey=081c9ac51ba16ab061d5efee583dcd2f&protocol=SNMP&templateName=MonitoringAgent.exe

deleteSysoid

POST

Enables deletion of SysOID

apiKey* - 访问OpManager服务器的API密钥。

typeName* - Template type name。

http://localhost:8060/api/json/admin/deleteSysoid?apiKey=081c9ac51ba16ab061d5efee583dcd2f&typeName=3com 3500G-EI

editInterfaceTemplates

POST

Edit Interface Template

apiKey* - 访问OpManager服务器的API密钥。

typeName* - Template type name。

intfEnabled* - on or off。

statusPoll* - on。

enableIntfUtilTemplate – on or off。

enableIntfErrorTemplate – on or off。

enableIntfDiscTemplate – on or off。

If enableIntfUtilTemplate is on,
pollInterval* – Polling interval (integer)。

failureThreshold* – Threshold failure value (integer)。

statusPollFT* – Status polling (integer)。

if enableIntfErrorTemplate is on,
utilThreshold* – threshold value (integer)。

utilRearm* – threshold rearm value (integer)。

utilCondition* – threshold condition (integer)。

if enableIntfDiscTemplate is on,
errorThreshold* - error threshold value (integer)。

errorRearm* - error Rearm value (integer)。

errorCondition* - error condition value (integer)

http://localhost:8060/api/json/admin/editInterfaceTemplates?apiKey=081c9ac51ba16ab061d5efee583dcd2f&intfEnabled=on&utilRearm=89&discCondition=>&errorRearm=89&discThreshold=90&statusPollFT=2&typeName=Ethernet&statusPoll=on&utilCondition=>&discRearm=89&utilThreshold=90&enableIntfDiscTemplate=on&errorThreshold=90&errorCondition=>&pollInterval=900&enableIntfErrorTemplate=on&enableIntfUtilTemplate=on&failureThreshold=9

getProcessTemplateDetails

GET

获取Process Template details

apiKey* - 访问OpManager服务器的API密钥。

templateName* - Process Template name

protocol* - Protocol to be used

http://localhost:8060/api/json/admin/getProcessTemplateDetails?apiKey=081c9ac51ba16ab061d5efee583dcd2f&protocol=CLI&templateName=httpd

getVendorMonitors

GET

Provides information about the monitors of particular vendor of the device。

apiKey* - 访问OpManager服务器的API密钥。

vendor* - Vendor of the device。

category* - device category。

http://localhost:8060/api/json/admin/getVendorMonitors?apiKey=081c9ac51ba16ab061d5efee583dcd2f&category=Server&vendor=Microsoft

listDeviceTemplates

GET

列出OpManager创建的所有the device templates created in OpManager。

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/admin/listDeviceTemplates?apiKey=081c9ac51ba16ab061d5efee583dcd2f

listInterfaceTemplates

GET

列出OpManager创建的所有the 接口模板 created。

apiKey* - 访问OpManager服务器的API密钥。

showMode* - allInterfaces or commonInterfaces

http://localhost:8060/api/json/admin/listInterfaceTemplates?apiKey=081c9ac51ba16ab061d5efee583dcd2f&showMode=commonInterfaces

listProcessTemplates

GET

列出OpManager创建的所有the process templates created。

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/admin/listProcessTemplates?apiKey=081c9ac51ba16ab061d5efee583dcd2f

updateDeviceTemplate

POST

Updates the device template。

apiKey* - 访问OpManager服务器的API密钥。

typeName* - Template type name。

IconName* - Template icon name。

pingInterval* - Ping Interval。

category* - Category of Device。

vendor* - Vendor of device。

isOidUpdated* - true或false。

oidStr* - OID String value。

isMonitorChanged* - true或false。

http://localhost:8060/api/json/admin/updateDeviceTemplate?apiKey=081c9ac51ba16ab061d5efee583dcd2f&category=switch&vendor=3com&IconName=switch.png&isOidUpdated=no&oidStr=.1.3.6.1.4.1.43.1.8.41&isMonitorChanged=no&typeName=3com 3500G-EI&pingInterval=60

updateProcessTemplateDetails

POST

Update Process Template details

apiKey* - 访问OpManager服务器的API密钥。

templateName* - Process Template name

DISPLAYNAME - Process Template Displayname

DESCRIPTION - Process Template description

CPUTHRESHOLDVALUES - CPU Threshold value(Need to give the below CPU Threshold details in case customer wants to add CPU Threshold)

CPUTHRESHOLDCONDITION - CPU Threshold condition(Either >=,=,
CPUTHRESHOLDUNITS - CPU Threshold unit(%)

CPUREARMVALUES - CPU Rearm value

CPUFAILURETHRESHOLD - CPU failure threshold value

MEMTHRESHOLDVALUES - Memory Threshold value(Need to give the below CPU Threshold details in case customer wants to add Memory Threshold)

MEMTHRESHOLDCONDITION - Memory Threshold condition(Either >=,=,
MEMTHRESHOLDUNITS - Memory Threshold unit(Either %/Bytes/KB/MB/GB)

MEMREARMVALUES - Memory Rearm value

MEMFAILURETHRESHOLD - Memory failure threshold value

ICTHRESHOLDVALUES - Instance count Threshold value(Need to give the below CPU Threshold details in case customer wants to add Instance count Threshold)

ICTHRESHOLDCONDITION - Instance count Threshold condition(Either >=,=,
ICTHRESHOLDUNITS - Instance count Threshold unit(%)

ICREARMVALUES - Instance count Rearm value

ICFAILURETHRESHOLD - Instance count failure threshold value

http://localhost:8060/api/json/admin/updateProcessTemplateDetails?apiKey=081c9ac51ba16ab061d5efee583dcd2f&ICTHRESHOLDCONDITION=>&ICREARMVALUES=39&ICTHRESHOLDUNITS=%&DISPLAYNAME= MSSQL &DESCRIPTION= test &templateName=MSSQL&MEMTHRESHOLDUNITS=%&ICTHRESHOLDVALUES=40&MEMTHRESHOLDVALUES=40&MEMTHRESHOLDCONDITION=>&CPUTHRESHOLDCONDITION=>&CPUREARMVALUES=39&MEMREARMVALUES=39&CPUTHRESHOLDUNITS=%&protocol=WMI&CPUFAILURETHRESHOLD=2&CPUTHRESHOLDVALUES=40&MEMFAILURETHRESHOLD=2&ICFAILURETHRESHOLD=2

viewDeviceTemplate

GET

Provides information on the template associated to the device

apiKey* - api key。

typeID* - Provide Type name。

http://localhost:8060/api/json/admin/viewDeviceTemplate?apiKey=081c9ac51ba16ab061d5efee583dcd2f&typeID=22

viewInterfaceTemplates

GET

View All 接口模板

apiKey* - api key。

typeName* - Template type name。

http://localhost:8060/api/json/admin/viewInterfaceTemplates?apiKey=081c9ac51ba16ab061d5efee583dcd2f&typeName=Ethernet

getAssociatedCredentials

GET

Obtains information on the credentials associated to a device

apiKey* - 访问OpManager服务器的API密钥。

name* – Name of the device whose credentials need to be fetched。

http://localhost:8060/api/json/device/getAssociatedCredentials?apiKey=081c9ac51ba16ab061d5efee583dcd2f&name=opman-k8r2s-64-3.testdomain.com

deletePerfomanceMonitors

POST

Deletes the performance monitor from the given device

apiKey* - 访问OpManager服务器的API密钥。

name* – Name of the device whose credentials need to be fetched。

policyName* - Name of the performance monitor。

http://localhost:8060/api/json/device/deletePerfomanceMonitors?apiKey=081c9ac51ba16ab061d5efee583dcd2f&policyName=Win-CPUUtilization&name=opman-k8r2s-64-2.testdomain.com

updateFileFolderTemplate

POST

Update File/folder monitoring template

apiKey* - 访问OpManager服务器的API密钥。

monitorId* - Monitor ID。

tempMoninterval* - Monitoring interval of the template。

tempDesc – File monitoring template description。

tempMonPath* - Monitoring file path。

protocol* - protocol of the device。

fileType* - File or Folder。

alertBasedType – Alert type ID (Critical, clear, info etc)。

wildCard* - Wild card characters。

operation* - Operation of file monitoring template。

chksubfolder* - Check Sub folder (true或false)。

tempName* – Template name。

http://localhost:8060/api/json/admin/updateFileFolderTemplate?apiKey=081c9ac51ba16ab061d5efee583dcd2f&monitorId=64&fileType=FILE&tempDesc=TEST DESCRIPTION&tempName=FileTemplate OR http://localhost:8060/api/json/admin/updateFileFolderTemplate&tempMoninterval=70&monitorId=68&tempMonPath=C:WINDOWS&apiKey=081c9ac51ba16ab061d5efee583dcd2f&protocol=WMI&tempDesc=TEST DESCRIPTION&fileType=FOLDER&alertBasedType=1&wildCard=*.*&operation=add&chksubfolder=false&tempName=FolderTemplate

editFileFolderTemplate

POST

Updates file/folder monitoring template

apiKey* - 访问OpManager服务器的API密钥。

monitorId* - File monitoring ID。

monitorType* - Type of monitoring (FILE or FOLDER)。

http://localhost:8060/api/json/admin/editFileFolderTemplate?apiKey=83155f195334a19df5e58a8a33a6f804&monitorId=21&monitorType=FILE

deleteFileFolderTemplate

POST

Delete File/folder template

apiKey* - 访问OpManager服务器的API密钥。

tempToDel* - Deleting file/folder template ID。

http://localhost:8060/api/json/admin/deleteFileFolderTemplate?apiKey=081c9ac51ba16ab061d5efee583dcd2f&tempToDel=22

saveFolderMonitorTemplates

POST

Updates folder monitoring template

apiKey* - 访问OpManager服务器的API密钥。

tempName* - 模板名称。

tempMoninterval* - Template monitoring interval。

tempMonPath* - Monitoring file/folder path。

protocol* - Protocol of the device。

tempDesc* - Template description。

fileType* - File/Folder。

alertBasedType* - Severity of the alert raised。

wildCard* – Wildcard file type。

operation* – 执行的操作 for the file/folder template。

chksubfolder* – Check sub folder (true或false)。

http://localhost:8060/api/json/admin/saveFolderMonitorTemplates?apiKey=081c9ac51ba16ab061d5efee583dcd2f&tempMoninterval=15&tempMonPath=C:WINDOWS&protocol=WMI&tempDesc=No Description&fileType=FOLDER&alertBasedType=2&wildCard=*.*&operation=add&chksubfolder=true&tempName=FolderTemplate

saveFileMonitorTemplates

POST

Updates File monitoring templates

apiKey* - 访问OpManager服务器的API密钥。

tempName* - 模板名称。

tempMoninterval* - Template monitoring interval。

tempMonPath* - Monitoring file/folder path。

protocol* - Protocol of the device。

tempDesc* - Template description。

fileType* - File/Folder。

operation* – 执行的操作 for the file/folder template。

http://localhost:8060/api/json/admin/saveFileMonitorTemplates?tempMoninterval=15&tempMonPath=C:classpathasdasd.bat&apiKey=081c9ac51ba16ab061d5efee583dcd2f&protocol=WMI&tempDesc=No Description&fileType=FILE&operation=add&tempName=FileTemplate

showFolderMonitorTemplates

POST

列出OpManager创建的所有folder monitoring templates

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/admin/showFolderMonitorTemplates?apiKey=081c9ac51ba16ab061d5efee583dcd2f

showFileMonitorTemplates

GET

Lists file monitoring templates

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/admin/showFileMonitorTemplates?apiKey=081c9ac51ba16ab061d5efee583dcd2f

addScritpTemplate

POST

添加new script monitoring template。

apiKey* - 访问OpManager服务器的API密钥。

scriptTemplateName* - Script monitoring template name。

thresholdEnabled* - true或false。

troubleThresholdCond* - Trouble threshold condition。

commandLine* - Command to execute。

workingDir – Executing directory。

scriptBody – Body/Message of the script template。

http://localhost:8060/api/json/admin/addScritpTemplate?apiKey=081c9ac51ba16ab061d5efee583dcd2f&scriptTemplateName=testing&thresholdEnabled=true&troubleThresholdCond=max&commandLine=cmd /c powershell.exe -ExecutionPolicy RemoteSigned .${FileName}.ps1 ${DeviceName} ${UserName} ${Password} svchost.exe&workingDir=${TempDir}&scriptBody=if($args[1] -eq $null -or $args[2] -eq $null)

testNewScriptTemplate

POST

Tests new script monitoring template

apiKey* - 访问OpManager服务器的API密钥。

deviceName* - Name of the device for which the template is to be applied。

scriptTemplateName* - Script monitoring template name。

description* - Script template description。

interval* - Interval。

CommandLine* - Command to execute。

workingDir – Executing directory。

scriptBody – Body/Message of the script template。

http://localhost:8060/api/json/admin/testNewScriptTemplate?deviceName=opman-k8r2s-64-2.testdomain.com&apiKey=081c9ac51ba16ab061d5efee583dcd2f&description=v2&workingDir=${TempDir}&commandLine=cmd /c powershell.exe -ExecutionPolicy RemoteSigned .${FileName}.ps1 ${DeviceName} ${UserName} ${Password} svchost.exe&interval=10&scriptTemplateName=testingnew&scriptBody=if($args[1] -eq $null -or $args[2] -eq $null)

testScriptTemplate

POST

Tests the script monitoring template

apiKey* - 访问OpManager服务器的API密钥。

deviceName* - Name of the device。

scriptTemplateName* - Script template name。

http://localhost:8060/api/json/admin/testScriptTemplate?apiKey=081c9ac51ba16ab061d5efee583dcd2f&deviceName=opman-k8r2s-64-2.testdomain.com&scriptTemplateName=testing

isScriptTemplateExists

GET

Checks whether the script monitoring template

apiKey* - 访问OpManager服务器的API密钥。

scriptTemplateName* - Script template name。

http://localhost:8060/api/json/admin/isScriptTemplateExists?apiKey=081c9ac51ba16ab061d5efee583dcd2f&scriptTemplateName=Cache Memory

deleteScriptTemplate

POST

Deletes the script monitoring template。

apiKey* - 访问OpManager服务器的API密钥。

scriptTemplateName* - Script template name。

http://localhost:8060/api/json/admin/deleteScriptTemplate?apiKey=081c9ac51ba16ab061d5efee583dcd2f&scriptTemplateName=testing

getScriptTemplateInfo

GET

Fetches script monitoring template information。

apiKey* - 访问OpManager服务器的API密钥。

scriptTemplateName* - Script template name。

http://localhost:8060/api/json/admin/getScriptTemplateInfo?apiKey=081c9ac51ba16ab061d5efee583dcd2f&scriptTemplateName=Cache Memory

Traps

addTrapParser

POST

添加Trap Parser

apiKey* - 访问OpManager服务器的API密钥。

trapParserName* - 陷阱解析器名称。

version* - version (v1 or v2)。
If version == v1
genType* : select gen type from genType lists
specType* : spec Type
oid* : Enterprise oid
If version == v2
oid* : Trap Oid

description - description

severity - OpManager Severity

message - Message

entity - Failure Component ($Source_$TrapName)_trap)

source - $Source or $Agent

matchCriteriaXML – Match Criteria (Should be given as xml format)

rearmCriteriaXML - Rearm Criteria (Should be given as xml format)

http://localhost:8060/api/json/admin/addTrapParser?apiKey=081c9ac51ba16ab061d5efee583dcd2f&version=v2&oid='.2.2.2.2.2.'&trapParserName=testing

deleteTrapForwarder

POST

Delete Trap Forwarder

apiKey* - api Key。

destHost* - 目标主机。

destPort* -目标端口。。

http://localhost:8060/api/json/admin/deleteTrapForwarder?apiKey=081c9ac51ba16ab061d5efee583dcd2f&destHost=opman-k8r2s-64-4&destPort=170

deleteTrapParser

POST

Delete Trap Parser

apiKey*- 访问OpManager服务器的API密钥。

trapParserName* - 陷阱解析器名称

http://localhost:8060/api/json/admin/deleteTrapParser?apiKey=081c9ac51ba16ab061d5efee583dcd2f&trapParserName=testing

disableTrapParser

POST

Disable Trap Parser

apiKey*- 访问OpManager服务器的API密钥。

trapParserName* - 陷阱解析器名称

http://localhost:8060/api/json/admin/disableTrapParser?apiKey=081c9ac51ba16ab061d5efee583dcd2f&trapParserName=LinkDown

enableTrapParser

POST

Enable Trap Parser

apiKey*- 访问OpManager服务器的API密钥。

trapParserName* - 陷阱解析器名称

http://localhost:8060/api/json/admin/enableTrapParser?apiKey=081c9ac51ba16ab061d5efee583dcd2f&trapParserName=LinkDown

getGenericTypes

GET

获取Trap Generic Types

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/admin/getGenericTypes?apiKey=081c9ac51ba16ab061d5efee583dcd2f

getTrapForwarders

GET

列出Trap Forwarders

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/admin/getTrapForwarders?apiKey=081c9ac51ba16ab061d5efee583dcd2f

getTrapParserInfo

GET

获取Trap Parser Details

apiKey*- 访问OpManager服务器的API密钥。

trapParserName* - 陷阱解析器名称

http://localhost:8060/api/json/admin/getTrapParserInfo?apiKey=081c9ac51ba16ab061d5efee583dcd2f&trapParserName=LinkDown

isTrapParserExists

GET

Is Trap Parser Exists

apiKey*- 访问OpManager服务器的API密钥。

trapParserName* - 陷阱解析器名称

http://localhost:8060/api/json/admin/isTrapParserExists?apiKey=081c9ac51ba16ab061d5efee583dcd2f&trapParserName=LinkDown

startTrapForwarder

POST

Start Trap Forwarder

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/admin/startTrapForwarder?apiKey=081c9ac51ba16ab061d5efee583dcd2f

stopTrapForwarder

POST

Stop Trap Forwarder

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/admin/stopTrapForwarder?apiKey=081c9ac51ba16ab061d5efee583dcd2f

updateTrapForwarder

POST

Update Trap Forwarder

apiKey*: 访问OpManager服务器的API密钥。

destHost* : Previous 目标主机。

destPort* : Previous目标端口。

newDestHost* : new 目标主机。

newDestPort* : new目标端口。

http://localhost:8060/api/json/admin/updateTrapForwarder?apiKey=081c9ac51ba16ab061d5efee583dcd2f&newDestPort=170&destHost=opman-k8r2s-64-6&destPort=165&newDestHost=opman-k8r2s-64-4

User Management

addUser

POST

Adds an user in OpManager。

apiKey* - 访问OpManager服务器的API密钥。

userName* - User name

password* - password

privilege* - Privilege for the user. Following privileges are available
* Administrators - Full Access
* Operators - Restricted Access。

bvName - Provides access to the devices devices grouped in the specified 业务视图. Multiple 业务视图s can be given by comma separated。

emailId - Email ID of the user。

landLine - Land line number of the user。

mobileNo - Mobile number of the user。

domainName - Name of the domain to which the user belongs to。

http://localhost:8060/api/json/admin/addUser?apiKey=081c9ac51ba16ab061d5efee583dcd2f&userName=rejoe@testdomain.com&privilege=Administrators&password=r&emailId=rejoe@testdomain.com

changePassword

POST

Allows you to change the password of a user。

apiKey* - 访问OpManager服务器的API密钥。

userName* - User name。

userId* – User ID。

domainName - Name of the domain。

oldPassword* – old password of the user。

newPassword* – new password of the user

http://localhost:8060/api/json/admin/changePassword?apiKey=081c9ac51ba16ab061d5efee583dcd2f&userName=rejoe@testdomain.com&newPassword=rr&userId=2&oldPassword=r

deleteUser

POST

Deletes a user。

apiKey* - 访问OpManager服务器的API密钥。

userName* - User name

http://localhost:8060/api/json/admin/deleteUser?apiKey=081c9ac51ba16ab061d5efee583dcd2f&userName=rejoe@testdomain.com

listUsers

GET

列出OpManager创建的所有users created in OpManager。

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/admin/listUsers?apiKey=081c9ac51ba16ab061d5efee583dcd2f

updateContactDetails

POST

Allows you to update the contact details of a user。

apiKey* - 访问OpManager服务器的API密钥。

userName* - User name。

userId* – User ID。

domainName - Name of the domain。

emailId* - emailid of the user。

phoneNumber – phone number of the user。

mobileNumber – mobile number of the user

http://localhost:8060/api/json/admin/updateContactDetails?apiKey=081c9ac51ba16ab061d5efee583dcd2f&userName=rejoe@testdomain.com&emailId=user1@testing.com&domainName=testdomain&userId=10&phoneNumber=04424453446&mobileNumber=04424453446

Virtualization

getAllDatastoreDetails

GET

Provides the Datastore ID, Host ID, and Datastore Name for all the datastores。

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/device/getAllDatastoreDetails?apiKey=081c9ac51ba16ab061d5efee583dcd2f

getAllHostDetails

GET

Provides Entity ID, MO_ID, MO_NAME, Entity_Name and Entity_ID for all the hosts

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/device/getAllHostDetails?apiKey=081c9ac51ba16ab061d5efee583dcd2f

getAllVMDetails

GET

Provides Entity ID, MO_ID, MO_NAME, Entity_Name and Entity_ID for all the virtual machine

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/device/getAllVMDetails?apiKey=081c9ac51ba16ab061d5efee583dcd2f

getVirtualDeviceDetails

GET

Provides details about the Parent and Child relationship of the device associated with it. e.g. if we provided hosts means it will gives details about vCenter and VM/Datastore associated with that host。

apiKey* - 访问OpManager服务器的API密钥。

deviceName* - Name of the VM device

http://localhost:8060/api/json/device/getVirtualDeviceDetails?apiKey=6d36ff8426cff396b81b248e5c458604&deviceName=esx-2.testdomain.com

getVirtualMachineInfo

GET

Provides VM CPU Usage, Powered ON/Off Status, System Uptime, Memory allocation etc..,

apiKey* - 访问OpManager服务器的API密钥。

deviceName* - Name of the VM device

http://localhost:8060/api/json/device/getVirtualMachineInfo?apiKey=081c9ac51ba16ab061d5efee583dcd2f

Dashboard

listCCTVView

GET

列出OpManager创建的所有the CCTV views

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/dashboard/listCCTVView?apiKey=081c9ac51ba16ab061d5efee583dcd2f

getCCTVView

GET

Gets CCTV view widgets/dashboards

apiKey* - 访问OpManager服务器的API密钥。

cctvID* - cctv ID。

http://localhost:8060/api/json/dashboard/getCCTVView?apiKey=081c9ac51ba16ab061d5efee583dcd2f&cctvID=1

deleteCCTVView

POST

Deletes CCTV view

apiKey* - 访问OpManager服务器的API密钥。

cctvID* - cctv ID。

http://localhost:8060/api/json/dashboard/deleteCCTVView&cctvID=2&apiKey=081c9ac51ba16ab061d5efee583dcd2f

addCCTVView

POST

添加new CCTV view

dashboardId* - dashboard ID。

cctvName* - name of the cctv。

cctvDescription* - CCTV id

time* - refreshing 时间间隔

http://localhost:8060/api/json/dashboard/addCCTVView?apiKey=081c9ac51ba16ab061d5efee583dcd2f&dashboardId=1&cctvName=testcctv&cctvDescription=newcctv&time=5

getDashBoardsForCCTV

GET

获取dashboards for the given CCTV view

apiKey* - 访问OpManager服务器的API密钥。

cctvID* - cctv ID。

http://localhost:8060/api/json/dashboard/getDashBoardsForCCTV?apiKey=081c9ac51ba16ab061d5efee583dcd2f&cctvID=1

deleteWidget

POST

Deletes the widget in dashboard page

apiKey* - 访问OpManager服务器的API密钥。

widgetID* - Widget ID

http://localhost:8060/api/json/dashboard/deleteWidget?apiKey=081c9ac51ba16ab061d5efee583dcd2f&widgetID=240

embedWidget

POST

Embeds URL of a widget

apiKey* - 访问OpManager服务器的API密钥。

regenerate* - true或false

height* - height of the widget

width* - width of the widget content

http://localhost:8060/api/json/dashboard/embedWidget?apiKey=081c9ac51ba16ab061d5efee583dcd2f&widgetID=144&regenerate=true&height=10&width=10

showWidgets

GET

Display all available widgets in a dashboard

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/dashboard/showWidgets?apiKey=081c9ac51ba16ab061d5efee583dcd2f

showDashboard

GET

Display dashboard contents

apiKey* - 访问OpManager服务器的API密钥。

dashboardID* - dashboard ID。

http://localhost:8060/api/json/dashboard/showDashboard?apiKey=081c9ac51ba16ab061d5efee583dcd2f&dashboardID=1

deleteDashboard

POST

Deletes a dashboard

apiKey* - 访问OpManager服务器的API密钥。

dashboardID* - dashboard ID。

http://localhost:8060/api/json/dashboard/deleteDashboard?apiKey=081c9ac51ba16ab061d5efee583dcd2f&dashboardID=7

updateDashboardLayout

POST

Updates dashboard layout

apiKey* - 访问OpManager服务器的API密钥。

dashboardName* - name of the dashboard。

columnWidth* - width。

numberOfColumns* - Number of the columns。

dashboardID* - ID of the dashboard。

dashboardDescription – Description of the dashboard。

http://localhost:8060/api/json/dashboard/updateDashboardLayout?apiKey=081c9ac51ba16ab061d5efee583dcd2f&dashboardName=test&columnWidth=100&numberOfColumns=1&dashboardID=7&dashboardDescription=dess

editDashboardLayout

POST

Edit dashboard layout

apiKey* - 访问OpManager服务器的API密钥。

dashboardID* - dashboard ID。

http://localhost:8060/api/json/dashboard/editDashboardLayout?apiKey=081c9ac51ba16ab061d5efee583dcd2f&dashboardID=1

createDashboard

POST

Creates new dashboard view

apiKey* - API Key to access to your OpManager。

dashboardName* - Name of the dashboard。

columnWidth* - column width

numberOfColumns* - number of columns。

selectedWidgets* - widget Ids

dashboardDescription – Description of the dashboard。

http://localhost:8060/api/json/dashboard/createDashboard?apiKey=081c9ac51ba16ab061d5efee583dcd2f&dashboardName=test&columnWidth=100&numberOfColumns=1&selectedWidgets=144&dashboardDescription=desssc

getWidget

GET

Fetches all widgets available in the given dashboard

apiKey* - 访问OpManager服务器的API密钥。

dashboardName* - dashboard ID。

http://localhost:8060/api/json/dashboard/getWidgetsList?dashboardName=ThahirDashboard&apiKey=6d36ff8426cff396b81b248e5c458604

getWidgetData

GET

Displays the data present in the given widget

apiKey* - 访问OpManager服务器的API密钥。

widgetID* - Widget ID

http://localhost:8060/api/json/dashboard/getWidgetData?apiKey=83155f195334a19df5e58a8a33a6f804&widgetID=255

getWidgetsList

GET

Fetches all widgets available in the given dashboard

apiKey* - 访问OpManager服务器的API密钥。

dashboardName* - dashboard ID。

http://localhost:8060/api/json/dashboard/getWidgetsList?apiKey=081c9ac51ba16ab061d5efee583dcd2f&dashboardName=dashboardoverview

editCCTVView

POST

Enables editing the CCTV view for configuring CCTV columns

apiKey* - 访问OpManager服务器的API密钥。

cctvName* - Name of the CCTV view。

cctvDescription – Description of the CCTV view。

cctvID* - CCTV Id。

time* - Refreshing interval。

dashboardId* - Dashboard ID。

http://localhost:8060/api/json/dashboard/editCCTVView?apiKey=081c9ac51ba16ab061d5efee583dcd2f&cctvName=testcctv&cctvDescription=newcctv&cctvID=2&time=5&dashboardId=2

getDashboardList

GET

Fetches all available dashboards

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/dashboard/getDashboardList?apiKey=081c9ac51ba16ab061d5efee583dcd2f

Credential Manager

addSNMPV3Credential

POST

添加new SNMP V3 credential

apiKey* - 访问OpManager服务器的API密钥。

port* – Protocol端口号。

authPwd* - Credential username。

privPwd* – Credential passoword。

update – true或false。

credentialName* - Credential name。

desc – Credential description。

privProtocol* – Type of encryption for the protocol。

username* - Username for the encryption。

retries* - Connection retries count。

contextname* - Context name。

timeout* - Connection timeout。

authProtocol* - Authentication protocol。

http://localhost:8060/api/json/admin/addSNMPV3Credential?apiKey=1d626117b2ac31145ce6bca49bb0458b&port=161&privPwd=privUser&update=false&credentialName=snmpV3credential&desc=v3 credential&privProtocol=DES&authPwd=authUser&username=auth&retries=1&contextname=authUser&timeout=10&authProtocol=MD5

addVMWareCredential

POST

添加new Vmware credential。

apiKey* - 访问OpManager服务器的API密钥。

username* - Username。

autovmdiscovery* - Auto-discovery (on or off)。

update* - true或false。

credentialName* - Credential name。

timeout* - Timeout value。

password* - Credential password。

port* - Credential端口号

desc – Credential description。

http://localhost:8060/api/json/admin/addVMWareCredential?apiKey=081c9ac51ba16ab061d5efee583dcd2f&username=root&autovmdiscovery=off&update=false&credentialName=vm&timeout=40&password=abc123&port=443&desc=ddddd

addLinuxCredential

POST

Adds a Linux credential

apiKey* - 访问OpManager服务器的API密钥。

update* - true或false。

pwpmt* - Prompt for password (true或false)。

credentialName* - Credential name。

cmdpmt* - Command prompt (credentials)。

protocol* - Protocol name。

username* - Username。

portno* -端口号。

logpmt* - Log prompt。

password* - Credential password。

cliTimeout* - CLI credential timeout。

http://localhost:8060/api/json/admin/addLinuxCredential?update=false&pwpmt=:&credentialName=LinuxTelnet&cmdpmt=$&protocol=telnet&username=test&portno=23&logpmt=:&password=test123&apiKey=83155f195334a19df5e58a8a33a6f804&cliTimeout=10

addWindowsCredential

POST

添加new windows credential。

apiKey* - 访问OpManager服务器的API密钥。

credentialName* - Credential name。

username* - Username (domainnameusername)。

password* - Password。

http://localhost:8060/api/json/admin/addWindowsCredential?apiKey=081c9ac51ba16ab061d5efee583dcd2f
&credentialName=win&username=workgroupadministrator&password=Vembu123

addSNMPV1Credential

POST

添加new SNMP V1 credential。

apiKey* - 访问OpManager服务器的API密钥。

credentialName* - Credential name。

writeCommunity* - Write community password。

readCommunity* - Read community password。

http://localhost:8060/api/json/admin/addSNMPV1Credential?apiKey=081c9ac51ba16ab061d5efee583dcd2f&credentialName=test1&writeCommunity=Public&readCommunity=Public

WorkFlow

getWorkflowList

GET

列出OpManager创建的所有the workflows associated to a device。

apiKey* - 访问OpManager服务器的API密钥。

http://localhost:8060/api/json/workflow/getWorkflowList?apiKey=081c9ac51ba16ab061d5efee583dcd2f

triggerWorkflow

POST

Allows to trigger a workflow on a device。

apiKey* - 访问OpManager服务器的API密钥。

workflowName* - Name of the workflow that has to be executed。

deviceName* - Name of the device on which the workflow has to be executed。

http://localhost:8060/api/json/workflow/triggerWorkflow?apiKey=081c9ac51ba16ab061d5efee583dcd2f&deviceName=opman-k8r2s-64-3.testdomain.com&workflowName=Instant Device Check

* Mandatory parameters
** Mandatory if Auto-login is enabled。

REST API	Method	Description	Parameters	Sample URL
getCIList	GET	列出all configuration item	TECHNICIAN_KEY* - API Key to access server。	http://172.18.10.195:8080/sdplus/CMDB/getCIList?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97
getAllChanges	GET	列出all Changes	TECHNICIAN_KEY* - API Key to access server。	http://172.18.10.195:8080/sdplus/Change/getAllChanges?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97
getAllContracts	GET	列出all Contract	TECHNICIAN_KEY* - API Key to access server。	http://172.18.10.195:8080/sdplus/Contract/getAllContracts?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97
getAllPurchase	GET	列出all Purchase	TECHNICIAN_KEY* - API Key to access server。	http://172.18.10.195:8080/sdplus/Purchase/getAllPurchase?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97
getAllProblems	GET	列出all Problem	TECHNICIAN_KEY* - API Key to access server。	http://172.18.10.195:8080/sdplus/Problem/getAllProblems?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97
getCIInfo	GET	获取details of configuration items	TECHNICIAN_KEY* - API Key to access server。	http://172.18.10.195:8080/sdplus/CMDB/getCIInfo?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&ciID=603
getAssetRelationShips	GET	获取Mapdetails of Relationship	TECHNICIAN_KEY* - API Key to access server。	http://172.18.10.195:8080/sdplus/CMDB/getAssetRelationShips?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&ciID=603
getHardwareDetails	GET	获取details of ci Hardware	TECHNICIAN_KEY* - API Key to access server。 *ciID - Configuration Item ID**	http://172.18.10.195:8080/sdplus/CMDB/getHardwareDetails?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&ciID=603
getSoftwareDetails	GET	获取details of asset - software	TECHNICIAN_KEY* - API Key to access server。 *ciID - Configuration Item ID**	http://172.18.10.195:8080/sdplus/CMDB/getSoftwareDetails?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&format=json&ciID=603
getSystemDetails	GET	获取details of asset - system	TECHNICIAN_KEY* - API Key to access server。 *ciID - Configuration Item ID**	http://172.18.10.195:8080/sdplus/CMDB/getSystemDetails?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&ciID=603
getRPCDetails	GET	获取details of asset associated - Request,change,problem	TECHNICIAN_KEY* - API Key to access server。 *ciID - Configuration Item ID**	http://172.18.10.195:8080/sdplus/CMDB/getRPCDetails?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&ciID=603
getScanDetails	GET	获取details of asset - Scan	TECHNICIAN_KEY* - API Key to access server。 *ciID - Configuration Item ID**	http://172.18.10.195:8080/sdplus/CMDB/getScanDetails?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&ciID=603
getContractsForAsset	GET	获取details of asset associated contracts	TECHNICIAN_KEY* - API Key to access server。 *ciID - Configuration Item ID**	http://172.18.10.195:8080/sdplus/CMDB/getContractsForAsset?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&ciID=603
getCostDetails	GET	获取cost details of asset	TECHNICIAN_KEY* - API Key to access server。 *ciID - Configuration Item ID**	http://172.18.10.195:8080/sdplus/CMDB/getCostDetails?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&ciID=603
getProblemsInfo	GET	获取problem details	TECHNICIAN_KEY* - API Key to access server。 *ProblemID - Problem ID**	http://172.18.10.195:8080/sdplus/Problem/getProblemsInfo?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&ProblemID=1
getProblemAnalysis	GET	获取problem analysis details	TECHNICIAN_KEY* - API Key to access server。 *ProblemID - Problem ID**	http://172.18.10.195:8080/sdplus/Problem/getProblemAnalysis?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&ProblemID=1
getProblemSolution	GET	获取solution details for problem	TECHNICIAN_KEY* - API Key to access server。 *ProblemID - Problem ID**	http://172.18.10.195:8080/sdplus/Problem/getProblemSolution?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&ProblemID=1
getProblemTask	GET	获取task to be performed for problem	TECHNICIAN_KEY* - API Key to access server。 *ProblemID - Problem ID**	http://172.18.10.195:8080/sdplus/Problem/getProblemTask?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&ProblemID=1
getProblemIncidents	GET	获取associated incident/request for problem	TECHNICIAN_KEY* - API Key to access server。 *ProblemID - Problem ID**	http://172.18.10.195:8080/sdplus/Problem/getProblemIncidents?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&ProblemID=1
getProblemHistory	GET	获取problem history	TECHNICIAN_KEY* - API Key to access server。 *ProblemID - Problem ID**	http://172.18.10.195:8080/sdplus/Problem/getProblemHistory?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&ProblemID=1
getChangeInfo	GET	获取change details	TECHNICIAN_KEY* - API Key to access server。 *ChangeID - Change ID**	http://172.18.10.195:8080/sdplus/Change/getChangeInfo?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&ChangeID=2
getContractDetails	GET	获取Contract details	TECHNICIAN_KEY* - API Key to access server。 *contractID - Contract ID**	http://172.18.10.195:8080/sdplus/Contract/getContractDetails?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&contractID=303
getContractedAssets	GET	获取asset associated with the contract	TECHNICIAN_KEY* - API Key to access server。 *contractID - Contract ID**	http://172.18.10.195:8080/sdplus/Contract/getContractedAssets?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&format=json&contractID=303
getContractRenewal	GET	获取contract renewal details	TECHNICIAN_KEY* - API Key to access server。 *contractID - Contract ID**	http://172.18.10.195:8080/sdplus/Contract/getContractRenewal?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&contractID=303
getChildContract	GET	获取child contarct details	TECHNICIAN_KEY* - API Key to access server。 *contractID - Contract ID**	http://172.18.10.195:8080/sdplus/Contract/getChildContract?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&contractID=303
getPoDetails	GET	获取purchaseorder details	TECHNICIAN_KEY* - API Key to access server。 *PoID - Purchase order ID**	http://172.18.10.195:8080/sdplus/Purchase/getPoDetails?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&PoID=1
getInvoiceAndPayment	GET	获取invoice and payments details of PO	TECHNICIAN_KEY* - API Key to access server。 *PoID - Purchase order ID**	http://172.18.10.195:8080/sdplus/Purchase/getInvoiceAndPayment?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&PoID=1
getPoRequest	GET	获取Request associated with PO	TECHNICIAN_KEY* - API Key to access server。 *PoID - Purchase order ID**	http://172.18.10.195:8080/sdplus/Purchase/getPoRequest?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&PoID=1