REST API de OpManager

OpManager ofrece las REST API para agregar y buscar datos de OpManager. Usando estas API, puedes integrar OpManager con software de administración de TI/mesa de servicio de terceros.

 

 

¿Cómo funcionan las REST API de OpManager?

Las API funcionan con una clave de API. La clave API es única para cada cuenta de OpManager y tiene que pasar como parámetro en cada solicitud de API que se haga. Primero, genere una clave API.

 

Generar clave de API

Para generar una clave API, vaya a Settings > Basic Settings > REST API en el cliente web de OpManager y haga clic en Regenerate Key.

Lista API

Nombre de la API Formato API Método Descripción
Agregar usario addUser post Agrega un dominio en OpManager.
Agregar dominio addDomain post Adds a domain in OpManager.
Eliminar dominio deleteDomain post Elimina un dominio en OpManager.
Lista de credenciales listCredentials get Presenta la lista de credenciales creadas en OpManager.
Lista de usuarios listUsers get Presenta una lista de todos los usuarios creados en OpManager.
Eliminar usuario deleteUser post Elimina a un usuario.
Cambiar contraseña changePassword post Permite cambiar la contraseña de un usuario.
Actualizar los datos de contacto del usuario updateContactDetails post Permite actualizar los datos de contacto de un usuario.
Agregar programa de tiempo de inactividad addDowntimeSchedule post Agrega un nuevo programa de tiempo de inactividad
Actualizar programa de tiempo de inactividad updateDowntimeSchedule post Actualiza un programa específico de tiempo de inactividad
Recibir programa de tiempo de inactividad getDowntimeSchedule get Se utiliza para recibir toda la información sobre un programa de tiempo de inactividad en particular
Lista de programas de tiempo de inactividad listDownTimeSchedules get Presenta la lista de los programas de tiempo de inactividad creados.
Eliminar programas de tiempo de inactividad deleteDownTimeSchedules post Elimina un programador de tiempo de inactividad en particular.
Lista de plantillas de dispositivos listDeviceTemplates get Presenta una lista de todas las plantillas de dispositivos creadas en OpManager.
Lista de perfiles de notificación listNotificationProfiles get Presenta una lista de todos los perfiles de notificación creados en OpManager.
Lista de monitores de servicio listServiceMonitors get Presenta una lista de todos los monitores de servicio creados.
Lista de Servicios de Windows listWindowsServiceMonitors get Presenta una lista de todos los monitores de servicio de Windows creados.
Lista de reglas de Eventlog listEventLogRules get Presenta una lista de todas las reglas de log de eventos creadas.
Lista de reglas de Syslog listSysLogRules get Presenta una lista de todas las reglas de syslog creadas.
Lista plantillas de procesos listProcessTemplates get Presenta una lista de todas las plantillas de proceso creadas.
Lista de monitores de Url listURLMonitors get Presenta una lista de todos los monitores de URL creados.
Procesadores de trampas listTrapProcessors get Presenta una lista de todos los procesadores de trampas creados.
Monitores de Script listScriptMonitors get Presenta una lista de todos los monitores de script creados.
Recibir configuración del proxy GetProxyServerSettings get Proporciona la información de la configuración del servidor proxy.
Recibir configuración del servidor SMS GetSMSServerSettings get Proporciona la información de la configuración del servidor SMS.
Agregar configuración del servidor SMS configureSMSServerSettings post Permite configurar los ajustes del servidor de SMS.
Lista de reglas para la escalada de alarmas listAlarmEscalationRules get Presenta una lista de todas las reglas de escalada de alarma creadas.
Lista de probes listProbes get Presenta una lista de todos los probes disponibles en OpManager.
Lista de monitores de rendimiento listPerformanceMonitors get Presenta una lista de todos los monitores de rendimiento agregados.
Lista de plantillas de interfaz listInterfaceTemplates get Presenta una lista de todas las plantillas de interfaz creadas.
Recibir datos de mantenimiento de BD getDBMaintenanceData get Recibe toda la información sobre el mantenimiento de la BD
Establecer datos de mantenimiento de BD setDBMaintenanceData post Configura los parámetros de mantenimiento de la BD
Recibe la configuración del servidor de correo GetMailServerSettings get Proporciona la información de la configuración del servidor de correo.
Agregar dispositivo addDevice post Agrega un dispositivo.
Eliminar dispositivo. deleteDevice post Elimina un dispositivo.
Agregar dispositivo al BV addDeviceToBV post Agrega dispositivos a un Business View ya creado.
Agregar dispositivo a Google Map addDeviceToGMap post Agrega dispositivos a Google map.
Recibir información de la infraestructura addBusinessView post Proporciona la información de la infraestructura, es decir, servidores, routers, etc. gestionados por OpManager.
Recibir vistas de la infraestructura getInfrastructureDetailsView get Proporciona la información de un tipo de infraestructura en particular, por ejemplo: servidores.
Recibir dispositivos caídos getInfrastructureView get Proporciona la información de los dispositivos que están caídos.
Buscar dispositivo getDownDevices get Le permite buscar un dispositivo.
Todas las métricas de la WAN searchDevice get Presenta una lista de todos los monitores de la WAN creados.
Todas las métricas de VOIP getAllWanMetrics get Presenta una lista de todos los monitores de VoIP creados.
Re descubrir interfaces getAllVoipMetrics get Re-descubre interfaces.
Descubrir interfaz reDiscoverInterfaces post Descubre una interfaz.
>Descubrir interfaz discoverInterface post >Descubre una interfaz.
Agregar mapa Layer2 addLayer2Map post Agrega un nuevo mapa Layer2 en OpManager.
Descubrir mapa Layer2 discoverLayer2Map post Descubre un mapa Layer2 existente.
Eliminar mapa Layer2 deleteLayer2Map post Elimina un mapa Layer2
Descubre dispositivos Layer2 discoverLayer2Devices post Agrega nuevos dispositivos Layer2
Recibir dispositivos Layer2 descubiertos getDiscoveredLayer2Map get Reciba una lista de todos los dispositivos Layer2 ya descubiertos.
Agregar evento addEvent post Agrega un evento.
Principales dispositivos por eventos getTopDevicesByEvents get Presenta una lista de los principales dispositivos por recuento de eventos.
Lista de alarmas listAlarms get Presenta una lista de todas las alarmas disponibles.
Reconocer alarma acknowledgeAlarm post Permite reconocer una alarma.
Desconocer alarma unAcknowledgeAlarm post Permite desconocer una alarma.
Limpiar alarma clearAlarm post Limpia una alarma
Eliminar alarma deleteAlarm post Elimina una alarma.
Agregar notas a la alarma addNotes post Agrega notas a una alarma.
Recibir notas getAnnotation get Proporciona las notas disponibles para una alarma.
Recibir información de la alarma alarmProperties get Proporciona la información de una alarma, por ejemplo: estado, reconocimiento.
Principales dispositivos por alarmas getTopDevicesByAlarms get Proporciona la lista de los principales dispositivos por recuento de alarmas.
Ping al dispositivo getPingResponse get Hace ping a un dispositivo y proporciona la respuesta.
Trazar dispositivo getTraceResponse get Le permite recibir el trazado de ruta a un dispositivo.
Lista de dispositivos listDevices get Presenta una lista de todos los dispositivos agregados en OpManager.
Resumen del dispositivo getDeviceSummary get Proporciona el resumen de la información de un dispositivo.
Perfiles de notificación asociados getNotificationProfiles get Proporciona la lista de perfiles de notificación asociados a un dispositivo.
Flujos de trabajo asociados getWorkFlows get Proporciona la lista de flujos de trabajo asociados a un dispositivo.
Notas de dispositivo getDeviceNotes get Proporciona la información de notas como el número de piso y el nombre del departamento agregado a un dispositivo.
Monitores asociados/td> getAssociatedMonitors get Proporciona la lista de monitores asociados a un dispositivo.
Actualizar estado del dispositivo updateDeviceStatus get Hace ping al dispositivo y actualiza el estado correcto de un dispositivo.
Lista de interfaces listInterfaces get Presenta una lista de todas las interfaces en OpManager.
Recibir interfaces de dispositivo getInterfaces get Proporciona la lista de interfaces en un dispositivo.
Probe URL getProbeURL get Proporciona el URL del probe.
Agregar notas al dispositivo addNotesToDevice post Agrega notas a un dispositivo.
Resumen de la interfaz getInterfaceSummary get Proporciona el resumen de la información de una interfaz.
Datos del gráfico de disponibilidad getAvailabiltyGraphData get Proporciona los datos utilizados para calcular el gráfico de disponibilidad.
Notas de la interfaz getInterfaceNotes get Proporciona la información de las notas agregadas a una interfaz.
Monitores de interfaz getInterfaceMonitors get Proporciona la lista de monitores asociados a una interfaz.
Tipos de interfaz getInterfaceTypes get Proporciona el tipo de interfaz, por ejemplo: serial, ethernet.
Lista de flujo de trabajo para el dispositivo getWorkflowList get Presenta una lista de todos los flujos de trabajo asociados a un dispositivo.
Activar el flujo de trabajo para el dispositivo triggerWorkflow post Permite activar un flujo de trabajo en un dispositivo.
Información del Business View getBusinessDetailsView get Presenta una lista de todos los dispositivos disponibles en un business view.
Business views getBusinessView get Presenta una lista de todos los business views creados.
List Racks listRacks get Lists all the racks created.
Lista de Racks listFloors get Presenta una lista de todos los racks creados.
Lista de pisos getFloorDetails get Presenta una lista de todos los pisos creados.
Recibir información del piso getLayer2Maps get Proporciona la información del piso. Por ejemplo: tamaño del piso, tamaño del mosaico.
Recibir sondeos por segundo getPollsPerSec get Proporciona el valor actual de los sondeos por segundo de OpManager.
Configuración del sistema getSystemSettingsDetails get Proporciona la información de la configuración del sistema de OpManager.
Actualizar configuración del sistema updateSystemSettingsDetails get Permite actualizar la configuración del sistema.
Asociar perfil de notificación associateNotificationProfiles post Permite asociar múltiples perfiles de notificación a múltiples dispositivos.
 

Criterios

Identificación de criterios

Estado del sondeo (El dispositivo pierde 1/3/5 sondeos)

#0000000000000000000000000000000

(# representa el número de sondeos, puede ser reemplazado por 1 o 3 o 5 o a ;

1 para seleccionar 1 sondeo o 3 para seleccionar 3 sondeos o 5 para seleccionar 5 sondeos o a para seleccionar 1,3,5 sondeos)

Trampa › recibida 01000000000000000000000000000000
Interfaz -› problemas 00100000000000000000000000000000
Servicio › caído 00010000000000000000000000000000
Servicio Windows › caído 00001000000000000000000000000000
Logs de evento › genera alarma 00000100000000000000000000000000
SysLog › alarma generada 00000010000000000000000000000000
AdMonitor › caído 00000001000000000000000000000000
Exchange Monitor › caído 00000000100000000000000000000000
MSSQL Monitor › violado 00000000010000000000000000000000
AdService › caído 00000000001000000000000000000000
Exchange Service › caído 00000000000100000000000000000000
MSSQL Service › caído 00000000000010000000000000000000
Umbral › violado 00000000000001000000000000000000
Monitor de proceso › violado 00000000000000100000000000000000
Monitor IPSLA › violado 00000000000000010000000000000000
Monitor de archivo › violado 00000000000000001000000000000000
Monitor de carpetas › violado 00000000000000000100000000000000
Monitor de impresora › violado 00000000000000000010000000000000
Monitor UPS › caído 00000000000000000001000000000000
URL › caído 00000000000000000000100000000000
Monitor de dispositivo virtual › caído 00000000000000000000010000000000
Monitor Script › caído 00000000000000000000001000000000
Probe › caído 00000000000000000000000100000000
Agente › caído 00000000000000000000000010000000
Monitor de hardware › caído 00000000000000000000000001000000
Copia de seguridad NCM › Falló 00000000000000000000000000100000
Configuración NCM › cambios 00000000000000000000000000010000
Alarma NFA › genera alarma 00000000000000000000000000001000
UCS Fault recibido 00000000000000000000000000000100
Alarma de almacenamiento 00000000000000000000000000000010
Alarma › despejado 00000000000000000000000000000001
 
Información sobre REST API del Large Enterprise Edition:

 
Documentación de REST API de OpManager
REST API Método Descripción Parámetros URL de muestra
Módulo de Administrador
addServiceMonitor POST Agregar monitor de servicio
apiKey* - Clave API para acceder a su servidor OpManager.

serviceName* - Nombre del servicio que se añadirá

portNumber* - Número de puerto del servicio

timeOut - Valor de tiempo de espera en segundos. Valor por defecto 0.

failureThreshold - Valor de tiempo consecutivo para generar la alerta de caída del servicio. Valor por defecto 1.

autoDiscovery - Verdadero - Se necesita comprobar y agregar este servicio durante el descubrimiento. De lo contrario, es falso
http://localhost:8060/api/json/admin/addServiceMonitor?apiKey=081c9ac51ba16ab061d5efee583dcd2f&autoDiscovery=false&serviceName=test2&portNumber=119&timeOut=5&failureThreshold=1
addSysLogForwarder POST Agrega SysLog Forwarder
apiKey* - Clave API para acceder a su servidor OpManager.

destHost* - Host de destino.

destPort* - Puerto de destino(0 – 65536)
http://localhost:8060/api/json/admin/addSysLogForwarder?apiKey=081c9ac51ba16ab061d5efee583dcd2f&destHost=opman-k8r2s-64-3&destPort=515
addSysLogRule POST Agrega Regla SysLog

apiKey* - Clave API para acceder a su servidor OpManager.

ruleName* - Nombre de la regla

facilityName* - SysLog Facility

severityList* - Gravedad de SysLog (Separado por comas)

alertSeverity* - Gravedad de la alerta OpManager

alarmMessage* - Mensaje de alerta OpManager

matchString - String que coincide con mensaje syslog entrante

consecutiveTime* - tiempo consecutivo

timeInterval* - intervalo de tiempo
(si rearmFacilityName es seleccionado entonces rearmSeverityList debe ser seleccionado)

rearmFacilityName - nombre de la instalación para el rearme de syslog

rearmSeverityList - lista de gravedad para rearmar syslog

rearmMatchString - String que coincide con syslog entrante para el rearme
http://localhost:8060/api/json/admin/addSysLogRule?apiKey=081c9ac51ba16ab061d5efee583dcd2f&alertSeverity=1&facilityName=auth&ruleName=test11&alarmMessage=test&severityList=alert
addTrapForwarder POST Agrega Trap Forwarder apiKey* - Clave API para acceder a su servidor OpManager.

destHost* - Host de destino.

destPort* -Puerto de destino.
http://localhost:8060/api/json/admin/addTrapForwarder?apiKey=081c9ac51ba16ab061d5efee583dcd2f&destHost=opman-k8r2s-64-6&destPort=165
deleteCredential POST Eliminar credenciales apiKey* - Clave API para acceder a su servidor OpManager.

credentialName* - Nombre de la credencial.

isSNMPV3 – verdadero o falso
http://localhost:8060/api/json/admin/deleteCredential?apiKey=081c9ac51ba16ab061d5efee583dcd2f&credentialName=Public
deleteServiceMonitor POST Eliminar monitor de servicio apiKey* - Clave API para acceder a su servidor OpManager.

serviceName* - Nombre del servicio a ser eliminado
http://localhost:8060/api/json/admin/deleteServiceMonitor?apiKey=081c9ac51ba16ab061d5efee583dcd2f&serviceName=test2
getCredentialDetails GET Recibir información de credenciales apiKey* - Clave API para acceder a su servidor OpManager.

credentialName* - Nombre de la credencial.

type* - Tipo de dispositivo, ejemplo. Windows, Linux, SNMP v1/v2, SNMP v3 o Vmware.
http://localhost:8060/api/json/admin/getCredentialDetails?apiKey=081c9ac51ba16ab061d5efee583dcd2f&credentialName=Public&type=SNMP v1/v2
getDBMaintenanceData GET Proporciona la configuración de mantenimiento de la BD apiKey* - Clave API para acceder a su servidor OpManager. http://localhost:8060/api/json/admin/getDBMaintenanceData?apiKey=081c9ac51ba16ab061d5efee583dcd2f
getFlowRate GET Recibir velocidad de flujo de SysLog apiKey* - Clave API para acceder a su servidor OpManager. http://localhost:8060/api/json/admin/getFlowRate?apiKey=081c9ac51ba16ab061d5efee583dcd2f
getSystemSettingsDetails GET Proporciona la información de la configuración del sistema de OpManager. apiKey* - Clave API para acceder a su servidor OpManager.. http://localhost:8060/api/json/admin/getSystemSettingsDetails?apiKey=081c9ac51ba16ab061d5efee583dcd2f
setDBMaintenanceData POST Le permite configurar el mantenimiento de la BD. apiKey* - Clave API para acceder a su servidor OpManager.

alarmscount - el recuento de las alarmas se mantendrá.

rawdata - Estadísticas detalladas.

hourlydata -
Estadísticas por hora.

dailydata - Estadísticas diarias.
http://localhost:8060/api/json/admin/setDBMaintenanceData?apiKey=081c9ac51ba16ab061d5efee583dcd2f&alarmscount=10000&dailydata=365&rawdata=7&hourlydata=30
updateServiceMonitor POST Actualizar información del Monitor de Servicio apiKey* - Clave API para acceder a su servidor OpManager.

serviceName* - Nombre del servicio a actualizar

timeOut* - Valor de tiempo de espera a ser actualizado

failureThreshold* - Valor de tiempo consecutivo a ser actualizado.

autoDiscovery* - Verdadero - Se necesita comprobar y agregar este servicio durante el descubrimiento. De lo contrario, es falso
http://localhost:8060/api/json/admin/updateServiceMonitor?apiKey=081c9ac51ba16ab061d5efee583dcd2f&serviceName=test2&timeOut=10&autoDiscovery=true&failureThreshold=3
updateSystemSettingsDetails GET Permite actualizar la configuración del sistema. apiKey* - Clave API para acceder a su servidor OpManager..

ALARMMESSAGELENGTH -
Cualquier número entero positivo.

CLILOG – falso/verdadero.

DATACOLLECTIONRATE -
verdadero/falso

DEBUGPRINTS - falso/verdadero

POLLPERSECOND - verdadero/falso

SCHEDULERRATE - falso/verdadero

SNMPLOG - falso/verdadero

SNMPV3LOG - verdadero/falso

ShowAds - verdadero/falso

WMILOG - verdadero/falso

benchmarkupload - activar/desactivar

metrackupload - activar/desactivar

quicklinks – activar/desactivar
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
listPluginEvents GET Recibe eventos generados por la aplicación del plugin instalado
apiKey* - Clave API para acceder a su servidor OpManager.

pluginName* - Nombre del plugin cuyo evento se necesita.

eventTime* - Período en el que se generó el evento (para todos los eventos, seleccione All).
http://localhost:8060/api/json/alarm/listPluginEvents?apiKey=6d36ff8426cff396b81b248e5c458604&pluginName=All&eventTime=All
getPluginEventCount GET Recibe el conteo de los eventos generados por la aplicación del plugin instalado
apiKey* - Clave API para acceder a su servidor OpManager.

fromTime* - Hora de inicio.

toTime* - Hora de finalización.
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 Busca información de los plugins instalados
apiKey* - Clave API para acceder a su servidor OpManager.
http://localhost:8060/api/json/admin/getPluginDetails?apiKey=081c9ac51ba16ab061d5efee583dcd2f
getDeviceListForTestScript GET Lista de dispositivos para el script de prueba.
apiKey* - Clave API para acceder a su servidor OpManager.

executedFrom* - Nombre del dispositivo ejecutado (Servidor local).
http://localhost:8060/api/json/admin/getDeviceListForTestScript?apiKey=081c9ac51ba16ab061d5efee583dcd2f&executeFrom=Local Server
upadateTrapParser POST Actualizar el analizador de trampas
apiKey* - Clave API para acceder a su servidor OpManager.

version* - Versión.

oid* - OID del dispositivo.

TrapParserName* - Nombre del analizador de trampas.
http://localhost:8060/api/json/admin/upadateTrapParser?apiKey=081c9ac51ba16ab061d5efee583dcd2f&version=v2&oid='.2.2.2.2.2.'&trapParserName=testing
updateLanguageSettings POST Actualizar la configuración del idioma
apiKey* - Clave API para acceder a su servidor OpManager.

languageSelected* - Idioma seleccionado.
http://localhost:8060/api/json/admin/updateLanguageSettings?apiKey=6d36ff8426cff396b81b248e5c458604&languageSelected=fr_FR
getLanguageSettings GET Obtains language settings.
apiKey* - API Key to access your OpManager server.
http://localhost:8060/api/json/admin/getLanguageSettings?apiKey=1d626117b2ac31145ce6bca49bb0458b
addDeviceToNProfile *API applicable from 123307 POST Adds devices to a notification profile that is already created.

apiKey* - API Key to access your OpManager server.

deviceName* - MO Name of the device to which the notification profile has to be associated.
MO Name of the device can be fetched using device displayName(Select Name,DisplayName from ManagedObject where DisplayName='<deviceDisplayName>')

profileName* - Name of the notification profile.

criteria* - There are 32 criteria. mentioned required criteriaid(**Refer the list mentioned at the end of this table.

selectedseverities - There are 4 severities.(1,2,3,4 for Critical,Trouble,Attention,ServiceDown or 1,3 for Critical,Attention and like ) Severities to be selected for which you want to trigger the notification profile. Add multiple severities by a comma. If param not given by default all severites will be selected.

performanceMonitors - List of monitors for which you want to trigger the notification profile when threshold is violated. Add multiple monitors separated by a comma.

probeName - [additional param- Only for Central] - name of the probe

 

http://localhost/api/json/discovery/addDeviceToNProfile?apiKey=ac130763a309fcb1613e0b8a551950a2&deviceName=localhost.testdomainin.com&profileName=TestNotify&criteria=31001100001010000000000110000011&performanceMonitors=DiskUtilization,Win-CPUUtilization
triggerWorkflow POST Allows to trigger a workflow on a device. apiKey* - API Key to access your OpManager server.

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
deleteAgentDetails POST Delete agent devices
apiKey* - API Key to access your OpManager server.

selectedDevices* - Devices for deletion.
http://localhost:8060/api/json/admin/deleteAgentDetails?selectedDevices=1392094715&apiKey=6d36ff8426cff396b81b248e5c458604
updateAgentDetails POST Update agent device details
apiKey* - API Key to access your OpManager server.

agentKey* - MonitoringAgent Key.

mappedDevice* - Mapped device name.
http://localhost:8060/api/json/admin/updateAgentDetails?agentKey=1392094715&apiKey=6d36ff8426cff396b81b248e5c458604&mappedDevice=640
showAgentDetails GET Shows the installed agent details
apiKey* - API Key to access your OpManager server.
http://localhost:8060/api/json/admin/showAgentDetails?apiKey=6d36ff8426cff396b81b248e5c458604
deleteFailOverDetails POST Deletes the fail-over server details
apiKey* - API Key to access your OpManager server.
http://localhost:8070/api/json/admin/deleteFailOverDetails?apiKey=6d36ff8426cff396b81b248e5c458604
updateFailOverDetails POST Updates fail-over server details
apiKey* - API Key to access your OpManager server.
http://localhost:8070/api/json/admin/updateFailOverDetails?apiKey=6d36ff8426cff396b81b248e5c458604
listFailOverDetails GET Lists the fail-over server details
apiKey* - API Key to access your OpManager server.

serviceName* - Failover device name.
http://localhost:8060/api/json/admin/listFailOverDetails?serviceName=DNS&apiKey=081c9ac51ba16ab061d5efee583dcd2f
registerLicense POST Registers the license file
apiKey* - API Key to access your OpManager server.

fileName* - License File name.
http://localhost:8060/api/json/admin/registerLicense?apiKey=6d36ff8426cff396b81b248e5c458604
licenseDetails GET Fetches license details
apiKey* - API Key to access your OpManager server.
http://localhost:8060/api/json/admin/licenseDetails?apiKey=081c9ac51ba16ab061d5efee583dcd2f
getCredentialMappedDevices GET Lists devices mapped to the given credential
apiKey* - API Key to access your OpManager server.

credentialName* - License File name.
http://localhost:8060/api/json/admin/getCredentialMappedDevices?apiKey=081c9ac51ba16ab061d5efee583dcd2f&credentialName=Public
sendSIF POST Sends support information file.
apiKey* - API Key to access your OpManager server.

customerName* - Customer name/email ID.

phone* - Contact number.

subject* - Mail subject.

userMessage* - Mail body message.

fromAddress* - From email address.

supportFile* - File name or zip file.
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 Creates a support information zip file
apiKey* - API Key to access your OpManager server.
http://localhost:8060/api/json/admin/createSIF?apiKey=081c9ac51ba16ab061d5efee583dcd2f
viewLogs GET Lists all the OpManager logs
apiKey* - API Key to access your OpManager server.
http://localhost:8060/api/json/admin/viewLogs?apiKey=081c9ac51ba16ab061d5efee583dcd2f
updateJvmHeapSize POST Updates JVM Heap size
apiKey* - API Key to access your OpManager server.

jvmHeapSize* - New JVM Heap size
http://localhost:8060/api/json/admin/updateJvmHeapSize?apiKey=6d36ff8426cff396b81b248e5c458604&JvmHeapSize=5120
generateHeapDump POST Generates Heap dump file..
apiKey* - API Key to access your OpManager server.
http://localhost:8060/api/json/admin/generateHeapDump?apiKey=081c9ac51ba16ab061d5efee583dcd2f
GetThreadDump GET Fetches thread dump.
apiKey* - API Key to access your OpManager server.
http://localhost:8060/api/json/admin/GetThreadDump?apiKey=83155f195334a19df5e58a8a33a6f804
GetSystemInformation GET Obtains System information.
apiKey* - API Key to access your OpManager server.
http://localhost:8060/api/json/admin/GetSystemInformation?apiKey=081c9ac51ba16ab061d5efee583dcd2f
getProcessTemplateAssociatedDevices GET Fetch the Process templates associated devices.
apiKey* - API Key to access your OpManager server.

protocol* - Type of the protocol.

templateID* - ID of the template/process.
http://localhost:8060/api/json/admin/getProcessTemplateAssociatedDevices?apiKey=1d626117b2ac31145ce6bca49bb0458b&protocol=WMI&templateID=2
GetRebrandDetails GET Fetches the rebrand details.
apiKey* - API Key to access your OpManager server.

alarmscount* - Alarms count.

rawdata* - Raw data (number of days).

hourlydata* - Hourly data (number of days).
http://localhost:8060/api/json/admin/GetRebrandDetails?apiKey=081c9ac51ba16ab061d5efee583dcd2f&alarmscount=10000&rawdata=7&hourlydata=30
rebrandOpManager GET Rebrands the product.
apiKey* - API Key to access your OpManager server.

productName* - Rebranded product name.
http://localhost:8060/api/json/admin/rebrandOpManager?apiKey=6d36ff8426cff396b81b248e5c458604&productName=ServerMonitoringTool
regenerateAPIKey GET Regenerates API Key
apiKey* - API Key to access your OpManager server.
http://localhost:8060/api/json/admin/regenerateAPIKey?apiKey=081c9ac51ba16ab061d5efee583dcd2f
getActualScheduleRate GET Gets actual schedule rate apiKey* - API Key to access your OpManager server.

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
deleteDomain POST Deletes the domain name.
apiKey* - API Key to access your OpManager server.

domainName* - Name of the domain.
http://localhost:8060/api/json/admin/deleteDomain?apiKey=081c9ac51ba16ab061d5efee583dcd2f&domainName=ZOHOCORP
addUrl POST Add new URL monitor
apiKey* - API Key to access your OpManager server.

pollInterval* - Poll Interval.

failureThreshold* - Failure threshold value.

errorContent* - Error content.

urlName* - Name of the URL.

password* - Password.

url* - URL to be monitored.

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.

update* - true or false.
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&update=false
Alarm Escalation
addAlarmEscalationRules POST Add Alarm Escalation rules apiKey* - API Key to access your OpManager server.

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 alarm escalation rules. 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 Alarm Escalation rules 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* - API Key to access your OpManager server.

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* - API Key to access your OpManager server.

entity - Entity of the alarm.
http://localhost:8060/api/json/alarm/acknowledgeAlarm?apiKey=081c9ac51ba16ab061d5efee583dcd2f&entity=222222222
addEvent POST Adds an event. apiKey* - API Key to access your OpManager server.

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, acknowledgement apiKey* - API Key to access your OpManager server.

entity* - Entity of the alarm.
http://localhost:8060/api/json/alarm/alarmProperties?apiKey=081c9ac51ba16ab061d5efee583dcd2f&entity=222222222
clearAlarm POST Clears an alarm. apiKey* - API Key to access your OpManager server.

entity* - Entity of the alarm.
http://localhost:8060/api/json/alarm/clearAlarm?apiKey=081c9ac51ba16ab061d5efee583dcd2f&entity=222222222
deleteAlarm POST Deletes an alarm. apiKey* - API Key to access your OpManager server.

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* - API Key to access your OpManager server.

entity* - Entity of the alarm.
http://localhost:8060/api/json/alarm/getAnnotation?apiKey=081c9ac51ba16ab061d5efee583dcd2f&entity=222222222
getTopDevicesByAlarms GET Provides the list of top devices by alarms count. apiKey* - API Key to access your OpManager server.

eventType* - Type of the Event eg. Trap or Eventlog Alarm
http://localhost:8060/api/json/alarm/getTopDevicesByAlarms?apiKey=081c9ac51ba16ab061d5efee583dcd2f&eventType=THRESHOLD-DOWN
getTopDevicesByEvents GET Lists the top devices by events count. apiKey* - API Key to access your OpManager server.

eventType* - Type of the Event eg. Trap or Eventlog Alarm
http://localhost:8060/api/json/events/getTopDevicesByEvents?apiKey=081c9ac51ba16ab061d5efee583dcd2f&eventType=THRESHOLD-DOWN
listAlarmEscalationRules GET Lists all the alarm escalation rules created. apiKey* - API Key to access your OpManager server. http://localhost:8060/api/json/admin/listAlarmEscalationRules?apiKey=081c9ac51ba16ab061d5efee583dcd2f
listAlarms GET List all the alarms available. apiKey* - API Key to access your OpManager server.

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

severity - 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 Lists all the notification profiles created in OpManager. apiKey* - API Key to access your OpManager server.
profileFilter- All - For Global profiles and for other type of profiles(Send+Email, Send+SMS, Send+Modem+SMS,
Run+System+Command,etc..)
isGlobal- false - for Device Specific Profiles Filter.
http://localhost:8060/api/json/admin/listNotificationProfiles?apiKey=641dc197c94dcabb6af38c64352e5954&isFluidic=true&profileFilter=All
associateNotificationProfiles POST Associate Notification Profiles
apiKey* - API Key to access your OpManager server.

profiles* - ProfileID of the profiles to be associated.

deviceName* - Name of the devices to be associated
 
http://localhost:80/api/json/admin/associateNotificationProfiles?apiKey=9c6f010cad72bc32abc984143cc5d505&profiles=301,302&deviceName=opman-k8r2s-64-3.testdomain.com,opman-k8r2s-64-4.testdomain.com
unAcknowledgeAlarm POST Allows to unacknowledge an alarm. apiKey* - API Key to access your OpManager server.

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* - API Key to access your OpManager server.

entity* - Entity (alarm ID)
http://localhost:8060/api/json/alarm/alarmProperties?apiKey=081c9ac51ba16ab061d5efee583dcd2f&entity=222222222
getAlarmList GET Lists all the alarms irrespective of the device/category
apiKey* - API Key to access your OpManager server.
http://localhost:8060/api/json/alarm/getAlarmList?apiKey=081c9ac51ba16ab061d5efee583dcd2f
listEvents GET Lists all generated events
apiKey* - API Key to access your OpManager server.
http://localhost:8060/api/json/events/listEvents?apiKey=6d36ff8426cff396b81b248e5c458604
Device discovery
addDevice POST Add a device. apiKey* - API Key to access your OpManager server.

deviceName* - Name of the device to be added.

netmask - Enter the netmask for discovering the device.

credentialName - Enter the appropriate credential.

type - Type of the device. 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* - API Key to access your OpManager server.

deviceName* - Name of the device to be added in business view.

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* - API Key to access your OpManager server.

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* - API Key to access your OpManager server.

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* - API Key to access your OpManager server.

domainName - Name of the domain that has to be deleted.
http://localhost:8060/api/json/admin/deleteDomain?apiKey=081c9ac51ba16ab061d5efee583dcd2f&domainName=ZOHOCORP
listCredentials GET Gives the list of credentials created in OpManager. apiKey* - API Key to access your OpManager server. http://localhost:8060/api/json/admin/listCredentials?apiKey=081c9ac51ba16ab061d5efee583dcd2f
listDownTimeSchedules GET Gives the list of downtime schedules created. apiKey* - API Key to access your OpManager server. http://localhost:8060/api/json/admin/listDownTimeSchedules?apiKey=83155f195334a19df5e58a8a33a6f804
RediscoverDevice POST Rediscovers a device
apiKey* - API Key to access your OpManager server.

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* - API Key to access your OpManager server.

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* - API Key to access your OpManager server.

type* - Type of the device (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* - API Key to access your OpManager server.

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* - API Key to access your OpManager server.

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
associateServiceMonitor POST Associate Service monitors to the specified device apiKey* - API Key to access your OpManager server.

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

serviceName* - Name of the service in comma-separated format.
http://localhost:8060/api/json/admin/associateServiceMonitor?deviceName=ctestlab-w2012.testdomain.com&apiKey=6d36ff8426cff396b81b248e5c458604&serviceName=WebLogic,Web,Telnet,SMTP
getAssociatedMonitors GET Provides the list of monitors associated to a device. apiKey* - API Key to access your OpManager server.

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* - API Key to access your OpManager server.

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* - API Key to access your OpManager server.

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* - API Key to access your OpManager server.

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 notification profiles associated to a device. apiKey* - API Key to access your OpManager server.

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* - API Key to access your OpManager server.

name* - Name of the device.

discoverFromDevice – true or 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* - API Key to access your OpManager server.

name* - name of the device.
http://localhost:8060/api/json/device/getWorkFlows?apiKey=83155f195334a19df5e58a8a33a6f804&name=opman-k8r2s-64-3.testdomain.com
listActiveProcesses POST List Active Processes apiKey* - API Key to access your OpManager server.

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

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

selectedCredential* - Indicator to use the associated password or selected credential (Either credentialSelected/associatedPassword)

credential - Specifies the credential to be used
http://localhost:8060/api/json/admin/listActiveProcesses?apiKey=081c9ac51ba16ab061d5efee583dcd2f&deviceName=opman-k8r2s-64-2.testdomain.com&protocol=WMI&credential=testcred&selectedCredential=credentialSelected

http://localhost:8060/api/json/admin/listActiveProcesses?apiKey=081c9ac51ba16ab061d5efee583dcd2f&deviceName=opman-k8r2s-64-2.testdomain.com&protocol=WMI&selectedCredential=associatedPassword
getAssociatedCredentials GET Obtains information on the credentials associated to a device
apiKey* - API Key to access your OpManager server.

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* - API Key to access your OpManager server.

policyName* - Name of the performance monitor.

graphName* - Graph name of the performance monitor.

name* - Name of the device.

checkNumeric* - true or 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 or 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 or 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 or False.

FirstTime – True or 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* - API Key to access your OpManager server.

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* - API Key to access your OpManager server.

deviceName* - Name of the device.

category* - Name of the performance monitors.

type* - Type of the device
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* - API Key to access your OpManager server.

firstTime* - true or false.

interfacename* - Name of the interface.

type* - Type of the device.

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* - API Key to access your OpManager server.

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* - API Key to access your OpManager server.

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* - API Key to access your OpManager server.

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* - API Key to access your OpManager server.

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* - API Key to access your OpManager server.

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* - API Key to access your OpManager server.

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* - API Key to access your OpManager server.

name* - Name of the device.

manage* - Set device in managed statue (true or 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* - API Key to access your OpManager server.

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* - API Key to access your OpManager server.

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* - API Key to access your OpManager server.

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 Get utilization of the given interfaces
apiKey* - API Key to access your OpManager server.

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* - API Key to access your OpManager server.

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* - API Key to access your OpManager server.

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* - API Key to access your OpManager server.

deviceName* - Type of the device.

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* - API Key to access your OpManager server.

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 Add an Event log rule apiKey* - API Key to access your OpManager server.

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* - API Key to access your OpManager server.

ruleid* - Event log rule id to be deleted.
http://localhost:8060/api/json/admin/deleteEventLogRules?apiKey=081c9ac51ba16ab061d5efee583dcd2f&ruleid=603
updateEventLogRules POST Updates the Eventlog rule. apiKey* - API Key to access your OpManager server.

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/updateEventLogRules?apiKey=081c9ac51ba16ab061d5efee583dcd2f&status=1&logFileName=Application&ruleName=testevent1&thresholdInterval=1&failureThreshold=1
viewEventLogRules GET Provides information on the event log rule apiKey* - API Key to access your OpManager server.

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* - API Key to access your OpManager server.

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* - API Key to access your OpManager server.

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* - API Key to access your OpManager server.

interfaceName - name of the interface
http://localhost:8060/api/json/device/getInterfaceSummary?apiKey=83155f195334a19df5e58a8a33a6f804&interfaceName=IF-opman-k8r2s-64-3.testdomain.com-4505
Inventory
getInterfaceTypes GET Provides the type of interface. eg: serial, ethernet.
apiKey* - API Key to access your OpManager server.
 
http://localhost:8060/api/json/device/getInterfaceTypes?apiKey=081c9ac51ba16ab061d5efee583dcd2f
getProbeURL GET Provides the URL of the probe. apiKey* - API Key to access your OpManager server.

name - name of the device.
http://localhost/api/json/device/addNotesToDevice?apiKey=ac130763a309fcb1613e0b8a551950a2&name=localhost.testdomain.com
listVirtualDevices GET Lists all the available virtual devices
apiKey* - API Key to access your OpManager server.

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* - API Key to access your OpManager server.

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* - API Key to access your OpManager server.

username* – username.

category* – Device category.
http://localhost:8060/api/json/device/fetchDevicesList?apiKey=081c9ac51ba16ab061d5efee583dcd2f&username=admin&category=Server
listDevices GET Lists all the devices added in OpManager. apiKey* - API Key to access your OpManager server.

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 Lists all the interfaces in OpManager. apiKey* - API Key to access your OpManager server. http://localhost:8060/api/json/device/listInterfaces?apiKey=83155f195334a19df5e58a8a33a6f804
getDevicePackageList GET Lists device package
apiKey* - API Key to access your OpManager server.
http://localhost:8060/api/json/device/getDevicePackageList?apiKey=081c9ac51ba16ab061d5efee583dcd2f
getCategoryList GET Lists all the available device categories
apiKey* - API Key to access your OpManager server.
http://localhost:8060/api/json/device/getCategoryList?apiKey=081c9ac51ba16ab061d5efee583dcd2f
getVendorList GET Lists all the vendors
apiKey* - API Key to access your OpManager server.
http://localhost:8060/api/json/device/getVendorList?apiKey=081c9ac51ba16ab061d5efee583dcd2f
Layer2 discovery
addLayer2Map POST Adds a Layer2 devices Map apiKey* - API Key to access your OpManager server.

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* - API Key to access your OpManager server.

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* - API Key to access your OpManager server.

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* - API Key to access your OpManager server.

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* - API Key to access your OpManager server.

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* - API Key to access your OpManager server.
http://localhost:8060/api/json/maps/getLayer2ScanDetails?apiKey=5022357be4231edff71ed25cf960457a
getLayer2Maps GET Lists all the Layer2 Maps available in Opmanager apiKey* - API Key to access your OpManager server. http://localhost:8060/api/json/maps/getLayer2Maps?apiKey=081c9ac51ba16ab061d5efee583dcd2f
Mail Server Settings
GetMailServerSettings GET Provides the details of mail server settings. apiKey* - API Key to access your OpManager server. http://localhost:8060/api/json/admin/GetMailServerSettings?apiKey=081c9ac51ba16ab061d5efee583dcd2f
getMailVariables GET Get send mail parameters
apiKey* - API Key to access your OpManager server.
http://localhost:8060/api/json/admin/getMailVariables?apiKey=081c9ac51ba16ab061d5efee583dcd2f
Maps
addBusinessView POST Adds a new business view. apiKey* - API Key to access your OpManager server.

bvName* - Name of the Business View.
http://localhost:8060/api/json/discovery/addBusinessView?apiKey=081c9ac51ba16ab061d5efee583dcd2f&bvName=test
addDeviceToBV POST Adds devices to a Business View that is already created. apiKey* - API Key to access your OpManager server.

deviceName* - Name of the device to be added in business view. Enter multiple device names separated by a comma.

bvName* - Name of the business view.
http://localhost:8060/api/json/discovery/addDeviceToBV?apiKey=081c9ac51ba16ab061d5efee583dcd2f&deviceName=opman-k8r2s-64-3.testdomain.com&bvName=test
getBusinessDetailsView GET Lists all the devices available in a business view. apiKey* - API Key to access your OpManager server.

bvName* - Name of the business view.

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 Lists all the business views created. apiKey* - API Key to access your OpManager server. http://localhost:8060/api/json/businessview/getBusinessView?apiKey=081c9ac51ba16ab061d5efee583dcd2f
getFloorDetails GET Provides the details of floor. eg, floor size, tile size. apiKey* - API Key to access your OpManager server.

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* - API Key to access your OpManager server. http://localhost:8060/api/json/discovery/getInfrastructureView?apiKey=081c9ac51ba16ab061d5efee583dcd2f
listFloors GET Lists all the floors created. apiKey* - API Key to access your OpManager server. http://localhost:8060/api/json/maps/listFloors?apiKey=1d626117b2ac31145ce6bca49bb0458b
listRacks GET Lists all the racks created. apiKey* - API Key to access your OpManager server. http://localhost:8060/api/json/maps/listRacks?apiKey=83155f195334a19df5e58a8a33a6f804
getUsersAssociatedToBV GET Displays all the users associated to the given business view
apiKey* - API Key to access your OpManager server.

BvName* - Business view name.
http://localhost:8060/api/json/businessview/getUsersAssociatedToBV?apiKey=83155f195334a19df5e58a8a33a6f804&bvName=test
getBVDetails GET Fetches information of the given BusinessView
apiKey* - API Key to access your OpManager server.

BvName* - Business view name.

viewId* - Business view Id.
http://localhost:8060/api/json/businessview/getBVDetails?apiKey=081c9ac51ba16ab061d5efee583dcd2f&viewId=1&bvName=test
Monitoring
addWindowsServiceMonitor POST Add Windows Service Monitors apiKey* - API Key to access your OpManager server.

serviceName* - Actual Service Name.

serviceDisplayName* - Service Display Name.

failureThreshold - Consecutive time 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* - API Key to access your OpManager server.

scheduleId* – ID of the schedule
http://localhost:8060/api/json/admin/deleteDownTimeSchedules?apiKey=83155f195334a19df5e58a8a33a6f804&scheduleId=1
addDowntimeSchedule POST Used to add a new downtime schedule. apiKey* - API Key to access your OpManager server.

operation* - Add operation for adding a schedule (Add)
scheduleName* - name of the downtime scheduler
status* - status of the schedule (enabled by default)
scheduleDesc - Description about the downtime schedule
recurrence* - Downtime frequency (OnceOnly | Daily | Weekly | Monthly)
selectDevicesMethod* - filter by option (Category | BV | Device | URL | GROUP)


(Only one param will be sent from below 5 params based on the selected filter)

selectedCateg - selected category
selectedDevices - selected devices
selectedBV - selected Business view
selectedURL - selected URLs
selectedLogicalGroup - selected logical group

(Below two params will be used only for onceOnly downtime frequency)

once_startat - yyyy-mm-dd hh:mm (year-month-date hour:min)
once_endat - yyyy-mm-dd hh:mm (year-month-date hour:min)

(Below three params will be used only for Daily downtime frequency)

from_time - hh:mm (hour:min)
to_time - hh:mm (hour:min)
daily_effectfrom - yyyy-mm-dd (year-month-date)

(Below four params will be used only for Weekly downtime frequency)

startday - (Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday)
endday - (Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday)
from_time - hh:mm (hour:min)
to_time - hh:mm (hour:min)

(Below param will be used only for Monthly downtime frequency)

monthlyType - (monthlyDate|monthlyDay)

(Below params will be used for monthly date wise frequency)

startday -month date (32 for last date of every month)
endday - month date (32 for last date of every month)
from_mins - minutes 00 to 59
to_mins - minutes 00 to 59
from_hrs - hours 00 to 23
to_hrs - hours 00 to 23

(Below params will be used for monthly day wise frequency)

weekOfMonth - week of the month (monthlyDate | monthlyDay)
weekday - day (Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday)
from_mins - minutes 00 to 59
to_mins - minutes 00 to 59
from_hrs - hours 00 to 23
to_hrs - hours 00 to 23
http://localhost/api/json/admin/addDowntimeSchedule?operation=Add&apiKey=83155f195334a19df5e58a8a33a6f804
updateDowntimeSchedule POST Used to update a downtime schedule. apiKey* - API Key to access your OpManager server.

operation* - Edit operation for editing a schedule (Edit)
MS_INSTANCEID* - Downtime scheduler id
scheduleId* - Downtime scheduler id
scheduleName* - name of the downtime scheduler
status* - status of the schedule (enabled by default)
scheduleDesc* - Description about the downtime schedule
recurrence* - Downtime frequency (OnceOnly|Daily|Weekly|Monthly)
selectDevicesMethod* - filter by option (Category|BV|Device|URL|GROUP)


(Only one param will be sent from below 5 params based on the selected filter)

selectedCateg - selected category
selectedDevices - selected devices
selectedBV - selected Business view
selectedURL - selected URLs
selectedLogicalGroup - selected logical group

(Below two params will be used only for onceOnly downtime frequency)

once_startat - yyyy-mm-dd hh:mm (year-month-date hour:min)
once_endat - yyyy-mm-dd hh:mm (year-month-date hour:min)

(Below three params will be used only for Daily downtime frequency)

from_time - hh:mm (hour:min)
to_time - hh:mm (hour:min)
daily_effectfrom - yyyy-mm-dd (year-month-date)

(Below four params will be used only for Weekly downtime frequency)

startday - (Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday)
endday - (Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday)
from_time - hh:mm (hour:min)
to_time - hh:mm (hour:min)

(Below param will be used only for Monthly downtime frequency)

monthlyType - (monthlyDate | monthlyDay)

(Below params will be used for monthly date wise frequency)

startday -month date (32 for last date of every month)
endday - month date (32 for last date of every month)
from_mins - minutes 00 to 59
to_mins - minutes 00 to 59
from_hrs - hours 00 to 23
to_hrs - hours 00 to 23

(Below params will be used for monthly day wise frequency)

weekOfMonth - week of the month (monthlyDate | monthlyDay)
weekday - day (Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday)
from_mins - minutes 00 to 59
to_mins - minutes 00 to 59
from_hrs - hours 00 to 23
to_hrs - hours 00 to 23
http://localhost/api/json/admin/updateDowntimeSchedule?operation=Edit&MS_INSTANCEID=14&scheduleId=14&apiKey=83155f195334a19df5e58a8a33a6f804
getDownTimeSchedule GET Used to fetch details about a particular downtime schedule apiKey* - API Key to access your OpManager server.

scheduleName* - Name of the downtime scheduler
http://localhost/api/json/admin/getDowntimeSchedule?scheduleName=test&apiKey=83155f195334a19df5e58a8a33a6f804
getAllVoipMetrics GET Lists all the VoIP monitors created. apiKey* - API Key to access your OpManager server. http://localhost:8060/api/json/discovery/getAllVoipMetrics?apiKey=83155f195334a19df5e58a8a33a6f804
getAllWanMetrics GET Lists all the WAN monitors created. apiKey* - API Key to access your OpManager server. http://localhost:8060/api/json/discovery/getAllWanMetrics?apiKey=83155f195334a19df5e58a8a33a6f804
getAvailabiltyGraphData GET Provides the data used to calculate the availability graph.

apiKey* - API Key to access your OpManager server.

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* - API Key to access your OpManager server. http://localhost:8060/api/json/discovery/getDownDevices?apiKey=83155f195334a19df5e58a8a33a6f804
getInterfaceMonitors GET Provides the list of monitors associated to an interface. apiKey* - API Key to access your OpManager server.

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* - API Key to access your OpManager server.

interfaceName - name of the interface
http://localhost:8060/api/json/device/getInterfaceNotes?apiKey=83155f195334a19df5e58a8a33a6f804&interfaceName=IF-opman-k8r2s-64-3.testdomain.com-4505
getPingResponse GET Pings a device and provides the response. apiKey* - API Key to access your OpManager server.

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* - API Key to access your OpManager server.

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* - API Key to access your OpManager server.

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 Lists all the event log rules created. apiKey* - API Key to access your OpManager server. http://localhost:8060/api/json/admin/listEventLogRules?apiKey=081c9ac51ba16ab061d5efee583dcd2f
listPerformanceMonitors GET Lists all the performance monitors added. apiKey* - API Key to access your OpManager server. http://localhost:8060/api/json/admin/listPerformanceMonitors?apiKey=081c9ac51ba16ab061d5efee583dcd2f
listScriptMonitors GET Lists all the script monitors created. apiKey* - API Key to access your OpManager server. http://localhost:8060/api/json/admin/listScriptMonitors?apiKey=081c9ac51ba16ab061d5efee583dcd2f
listServiceMonitors GET Lists all the service monitors created. apiKey* - API Key to access your OpManager server. http://localhost:8060/api/json/admin/listServiceMonitors?apiKey=081c9ac51ba16ab061d5efee583dcd2f
listSysLogRules GET Lists all the syslog rules created. apiKey* - API Key to access your OpManager server. http://localhost:8060/api/json/admin/listSysLogRules?apiKey=081c9ac51ba16ab061d5efee583dcd2f
listTrapProcessors GET Lists all the trap processor created. apiKey* - API Key to access your OpManager server. http://localhost:8060/api/json/admin/listTrapProcessors?apiKey=081c9ac51ba16ab061d5efee583dcd2f
listURLMonitors GET Lists all the URL monitors created. apiKey* - API Key to access your OpManager server. http://localhost:8060/api/json/admin/listURLMonitors?apiKey=5070623c57db770f93ca914dc7b598f8
listWindowsServiceMonitors GET Lists all the Windows service monitors created. apiKey* - API Key to access your OpManager server. http://localhost:8060/api/json/admin/listWindowsServiceMonitors?apiKey=081c9ac51ba16ab061d5efee583dcd2f
listStatusPollDetails GET List status poll details of particular interface type.
apiKey* - API Key to access your OpManager server.

typeName* - Type of the device/interface
http://localhost:8060/api/json/admin/listStatusPollDetails?apiKey=081c9ac51ba16ab061d5efee583dcd2f&typeName=Ethernet
TestMonitor GET Test Monitor action apiKey* - API Key to access your OpManager server.

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 updates the correct status of a device. apiKey* - API Key to access your OpManager server.

name* - name of the device.
http://localhost:8060/api/json/device/updateDeviceStatus?apiKey=081c9ac51ba16ab061d5efee583dcd2f&name=opman-k8r2s-64-3.testdomain.com
Proxy Server Settings
GetProxyServerSettings GET Provides the details of proxy server settings. apiKey* - API Key to access your OpManager server. http://localhost:8060/api/json/admin/GetProxyServerSettings?apiKey=081c9ac51ba16ab061d5efee583dcd2f
SMS Server Settings
configureSMSServerSettings POST Allows to configure the SMS server settings. apiKey* - API Key to access your OpManager server.

portno* - <Name of the Port(eg. COM1).

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 SMS server settings. apiKey* - API Key to access your OpManager server. http://localhost:8060/api/json/admin/GetSMSServerSettings?apiKey=081c9ac51ba16ab061d5efee583dcd2f
SysLogs
deleteSysLogForwarder POST Delete SysLog Forwarder apiKey* - API Key to access your OpManager server.

destHost* - Destination Host.

destPort* - Destination Port.
http://localhost:8060/api/json/admin/deleteSysLogForwarder?apiKey=081c9ac51ba16ab061d5efee583dcd2f&destHost=opman-k8r2s-64-2&destPort=516
deleteSysLogRule POST Delete SysLog Rule apiKey* - API Key to access your OpManager server.

ruleName* - Name of the rule
http://localhost:8060/api/json/admin/deleteSysLogRule?apiKey=081c9ac51ba16ab061d5efee583dcd2f&ruleName=test11
getSysLogAlertSeverityMap GET List SysLog AlertSeverityMap apiKey* - API Key to access your OpManager server. http://localhost:8060/api/json/admin/getSysLogAlertSeverityMap?apiKey=081c9ac51ba16ab061d5efee583dcd2f
getSysLogFacilityMap GET List SysLog FacilitiesMap apiKey* - API Key to access your OpManager server. http://localhost:8060/api/json/admin/getSysLogFacilityMap?apiKey=081c9ac51ba16ab061d5efee583dcd2f
getSysLogForwarders GET List SysLog Forwarders apiKey* - API Key to access your OpManager server.

ruleName* - Sys Log Rule Name.
http://localhost:8060/api/json/admin/getSysLogForwarders?apiKey=081c9ac51ba16ab061d5efee583dcd2f
getSysLogPort GET Get SysLog Ports apiKey* - API Key to access your OpManager server.

portNumber*- port Numbers(comma separated)
http://localhost:8060/api/json/admin/getSysLogPort?apiKey=081c9ac51ba16ab061d5efee583dcd2f
getSysLogRuleContent GET SysLog Rule Info apiKey* - API Key to access your OpManager server.

ruleName* - Sys Log Rule Name
http://localhost:8060/api/json/admin/getSysLogRuleContent?apiKey=081c9ac51ba16ab061d5efee583dcd2f&ruleName=Failed logins
getSysLogSeverityMap GET List SysLog SeverityMap apiKey* - API Key to access your OpManager server. http://localhost:8060/api/json/admin/getSysLogSeverityMap?apiKey=081c9ac51ba16ab061d5efee583dcd2f
isSysLogRuleExists GET Is SysLog Rule Exists apiKey* - API Key to access your OpManager server.

ruleName* - Sys Log Rule Name.
http://localhost:8060/api/json/admin/isSysLogRuleExists?apiKey=081c9ac51ba16ab061d5efee583dcd2f&ruleName=Failed logins
startSysLogForwarder POST Start SysLog Forwarder apiKey* - API Key to access your OpManager server. http://localhost:8060/api/json/admin/startSysLogForwarder?apiKey=081c9ac51ba16ab061d5efee583dcd2f
stopSysLogForwarder POST Stop SysLog Forwarder apiKey* - API Key to access your OpManager server. http://localhost:8060/api/json/admin/stopSysLogForwarder?apiKey=081c9ac51ba16ab061d5efee583dcd2f
updateSysLogForwarder POST Update SysLog Forwarder apiKey* - API Key to access your OpManager server.

destHost* - Previous Destination Host.

destPort* - Previous Destination Port.

newDestHost* - New Destination Host.

newDestPort* - New Destination Port.
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 Rule apiKey* - API Key to access your OpManager server.

ruleName* - Name of the rule

facilityName - SysLog Facility

severityList - SysLog Severity(Comma Separated)

alertSeverity - OpManager Alert Severity

alarmMessage - OpManager Alert Message

matchString - String matched with incoming syslog message

consecutiveTime - consecutive time

timeInterval - time interval
(if rearmFacilityName is selected then rearmSeverityList should be selected)

rearmFacilityName - facility name for rearm syslog

rearmSeverityList : severity list for rearm syslog

rearmMatchString : String matched with incoming syslog for rearm
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
addVendor POST Add new vendor name. apiKey* - api key.

vendor* - Vendor name of the device.
http://localhost:8060/api/json/admin/addVendor?apiKey=081c9ac51ba16ab061d5efee583dcd2f&vendor=testvendor3
addBulkProcessTemplate POST Add Process Template apiKey* - API key.

processArr* - Details of the Process template.
http://localhost:8060/api/json/admin/addBulkProcessTemplate?apiKey=081c9ac51ba16ab061d5efee583dcd2f&processArr=[{"processName":"Process_Name","displayName":"Display_Name","path":"Path","argument":"Arguments","matchPath":true,"matchArgs":true,"protocol":"WMI"}, ....]
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* - API Key to access your OpManager server.

templateId* - Process template Id to be associated. For Bulk template association, give template Ids 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&templateId=2
deleteDeviceTemplate POST Enables deletion of Device Templates. apiKey* - API Key to access your OpManager server.

typeName* - Template type name.
http://localhost:8060/api/json/admin/deleteDeviceTemplate?apiKey=081c9ac51ba16ab061d5efee583dcd2f&typeName=3com 3500G-EI
deleteProcessTemplate POST Delete Process Template apiKey* - API Key to access your OpManager server.

templateID* - Process Template Id to be deleted.

protocol* - protocol used to discover the process.
http://localhost:8060/api/json/admin/deleteProcessTemplate?apiKey=081c9ac51ba16ab061d5efee583dcd2f&protocol=SNMP&templateID=2
deleteSysoid POST Enables deletion of SysOID apiKey* - API Key to access your OpManager server.

typeName* - Template type name.
http://localhost:8060/api/json/admin/deleteSysoid?apiKey=081c9ac51ba16ab061d5efee583dcd2f&typeName=3com 3500G-EI
editInterfaceTemplates POST Edit Interface Template apiKey* - API Key to access your OpManager server.

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 Get Process Template details apiKey* - API Key to access your OpManager server.

templateID* - Process Template Id
http://localhost:8060/api/json/admin/getProcessTemplateDetails?apiKey=081c9ac51ba16ab061d5efee583dcd2f&templateID=2
getVendorMonitors GET Provides information about the monitors of particular vendor of the device. apiKey* - API Key to access your OpManager server.

vendor* - Vendor of the device.

category* - device category.
http://localhost:8060/api/json/admin/getVendorMonitors?apiKey=081c9ac51ba16ab061d5efee583dcd2f&category=Server&vendor=Microsoft
listDeviceTemplates GET Lists all the device templates created in OpManager. apiKey* - API Key to access your OpManager server.

rows - Number of records per page (default is 100)

page - Current page count
http://localhost:8060/api/json/admin/listDeviceTemplates?apiKey=081c9ac51bad5efee583dcd2f&rows=100&page=1&sortByColumn=totaldevices&sortByType=desc
GET Lists all the custom device templates created in OpManager. apiKey* - API Key to access your OpManager server.

rows - Number of records per page (default is 100)

page - Current page count

type - type of device template (custom/default)
http://localhost:8060/api/json/admin/listDeviceTemplates?apiKey=081c9ac51bad5efee583dcd2f&type=Custom&rows=100&page=1&sortByColumn=totaldevices&sortByType=desc
listInterfaceTemplates GET Lists all the interface templates created. apiKey* - API Key to access your OpManager server.

showMode* - allInterfaces or commonInterfaces
http://localhost:8060/api/json/admin/listInterfaceTemplates?apiKey=081c9ac51ba16ab061d5efee583dcd2f&showMode=commonInterfaces
listProcessTemplates GET Lists all the process templates created. apiKey* - API Key to access your OpManager server. http://localhost:8060/api/json/admin/listProcessTemplates?apiKey=081c9ac51ba16ab061d5efee583dcd2f
updateDeviceTemplate POST Updates the device template. apiKey* - API Key to access your OpManager server.

typeName* - Template type name.

IconName* - Template icon name.

pingInterval* - Ping Interval.

category* - Category of Device.

vendor* - Vendor of device.

isOidUpdated* - true or false.

oidStr* - OID String value.

isMonitorChanged* - true or 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* - API Key to access your OpManager server.

templateID* - Process Template ID

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

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&templateID=1&protocol=WMI&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 interface templates 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* - API Key to access your OpManager server.

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* - API Key to access your OpManager server.

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* - API Key to access your OpManager server.

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 or 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* - API Key to access your OpManager server.

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* - API Key to access your OpManager server.

tempToDel* - Deleting file/folder template ID.
http://localhost:8060/api/json/admin/deleteFileFolderTemplate?apiKey=081c9ac51ba16ab061d5efee583dcd2f&tempToDel=22
saveFolderMonitorTemplates POST Updates folder monitoring template
apiKey* - API Key to access your OpManager server.

tempName* - Name of the template.

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* – Operation to perform for the file/folder template.

chksubfldr* – Check sub folder (true or 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&chksubfldr=true&tempName=FolderTemplate
saveFileMonitorTemplates POST Updates File monitoring templates
apiKey* - API Key to access your OpManager server.

tempName* - Name of the template.

tempMoninterval* - Template monitoring interval.

tempMonPath* - Monitoring file/folder path.

protocol* - Protocol of the device.

tempDesc* - Template description.

fileType* - File/Folder.

operation* – Operation to perform 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 Lists all folder monitoring templates
apiKey* - API Key to access your OpManager server.

monitorType* - FOLDER
http://localhost:8060/api/json/admin/showFolderMonitorTemplates?apiKey=081c9ac51ba16ab061d5efee583dcd2f&monitorType=FOLDER
showFileMonitorTemplates GET Lists file monitoring templates
apiKey* - API Key to access your OpManager server.
http://localhost:8060/api/json/admin/showFileMonitorTemplates?apiKey=081c9ac51ba16ab061d5efee583dcd2f
deleteScriptTemplate POST Deletes the script monitoring template.
apiKey* - API Key to access your OpManager server.

scriptTemplateName* - Script template name.
http://localhost:8060/api/json/admin/deleteScriptTemplate?apiKey=081c9ac51ba16ab061d5efee583dcd2f&scriptTemplateName=testing
getScriptTemplateInfo GET Fetches script monitoring template information.
apiKey* - API Key to access your OpManager server.

scriptTemplateName* - Script template name.
http://localhost:8060/api/json/admin/getScriptTemplateInfo?apiKey=081c9ac51ba16ab061d5efee583dcd2f&scriptTemplateName=Cache Memory
Traps
addTrapParser POST Add Trap Parser apiKey* - API Key to access your OpManager server.

trapParserName* - Name of the trap parser.

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)
<?xml version="1.0" encoding="UTF-8" ?>
<MatchCriteria matchType="any" trapVersion="v1" >
<CRITERIA VarBindNo="0" MatchCondition="1" Message="sdasdas" />
<CRITERIA VarBindNo="0" MatchCondition="1" Message="sdsda" />
</MatchCriteria>

rearmCriteriaXML - Rearm Criteria (Should be given as xml format)
<?xml version="1.0" encoding="UTF-8" ?>
<RearmMatchCriteria matchType="all" trapVersion="v1" >
<CRITERIA VarBindNo="0" MatchCondition="1" Message="dasda" />
<CRITERIA VarBindNo="0" MatchCondition="2" Message="dsadas" />
</RearmMatchCriteria>
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* - Destination Host.

destPort* - Destination Port.
http://localhost:8060/api/json/admin/deleteTrapForwarder?apiKey=081c9ac51ba16ab061d5efee583dcd2f&destHost=opman-k8r2s-64-4&destPort=170
deleteTrapParser POST Delete Trap Parser apiKey*- API Key to access your OpManager server.

trapParserName* - name of the trap parser
http://localhost:8060/api/json/admin/deleteTrapParser?apiKey=081c9ac51ba16ab061d5efee583dcd2f&trapParserName=testing
disableTrapParser POST Disable Trap Parser apiKey*- API Key to access your OpManager server.

trapParserName* - name of the trap parser
http://localhost:8060/api/json/admin/disableTrapParser?apiKey=081c9ac51ba16ab061d5efee583dcd2f&trapParserName=LinkDown
enableTrapParser POST Enable Trap Parser apiKey*- API Key to access your OpManager server.

trapParserName* - name of the trap parser
http://localhost:8060/api/json/admin/enableTrapParser?apiKey=081c9ac51ba16ab061d5efee583dcd2f&trapParserName=LinkDown
getGenericTypes GET Get Trap Generic Types apiKey* - API Key to access your OpManager server. http://localhost:8060/api/json/admin/getGenericTypes?apiKey=081c9ac51ba16ab061d5efee583dcd2f
getTrapForwarders GET List Trap Forwarders apiKey* - API Key to access your OpManager server. http://localhost:8060/api/json/admin/getTrapForwarders?apiKey=081c9ac51ba16ab061d5efee583dcd2f
getTrapParserInfo GET Get Trap Parser Details apiKey*- API Key to access your OpManager server.

trapParserName* - name of the trap parser
http://localhost:8060/api/json/admin/getTrapParserInfo?apiKey=081c9ac51ba16ab061d5efee583dcd2f&trapParserName=LinkDown
isTrapParserExists GET Is Trap Parser Exists apiKey*- API Key to access your OpManager server.

trapParserName* - name of the trap parser
http://localhost:8060/api/json/admin/isTrapParserExists?apiKey=081c9ac51ba16ab061d5efee583dcd2f&trapParserName=LinkDown
startTrapForwarder POST Start Trap Forwarder apiKey* - API Key to access your OpManager server. http://localhost:8060/api/json/admin/startTrapForwarder?apiKey=081c9ac51ba16ab061d5efee583dcd2f
stopTrapForwarder POST Stop Trap Forwarder apiKey* - API Key to access your OpManager server. http://localhost:8060/api/json/admin/stopTrapForwarder?apiKey=081c9ac51ba16ab061d5efee583dcd2f
updateTrapForwarder POST Update Trap Forwarder apiKey*: API Key to access your OpManager server.

destHost* : Previous Destination Host

destPort* : Previous Destination Port

newDestHost* : new Destination Host.

newDestPort* : new Destination Port
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* - API Key to access your OpManager server.

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 business view. Multiple business views 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* - API Key to access your OpManager server.

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* - API Key to access your OpManager server.

userName* - User name
http://localhost:8060/api/json/admin/deleteUser?apiKey=081c9ac51ba16ab061d5efee583dcd2f&userName=rejoe@testdomain.com
listUsers GET Lists all users created in OpManager. apiKey* - API Key to access your OpManager server. http://localhost:8060/api/json/admin/listUsers?apiKey=081c9ac51ba16ab061d5efee583dcd2f
updateContactDetails POST Allows you to update the contact details of a user. apiKey* - API Key to access your OpManager server.

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
getVMWareDataStores GET Provides details of all the available datastore like Datastore ID, Datastore Name and Capacity (MB). name* - name of the vcenter

type - VCENTER|HOST|VM
http://localhost:8060/client/api/json/device/getVMWareDataStores?name=vcenter.test.domain.com&type=VCENTER
getVMWareHosts GET Provides details of all the available hosts like HostName, Memory Capacity(MB), OS Type and CPU Speed(MHz) name*- name of the vcenter http://localhost:8060/client/api/json/device/getVMWareHosts?name=vcenter.test.domain.com
getVMWareVMs GET Provides details of all the available VMware Virtual Machines like VM name, number of virtual CPUs, number of virtual disks, connection state and Memory(MB) name* - name of the vcenter| host| datastore

type - VCENTER|HOST|DATASTORE
http://localhost:8060/client/api/json/device/getVMWareVMs?name=vcenter.test.domain.com&type=VCENTER
getVmwareEntityMapViewDetails GET Provides mapping details for the device specified. For example, if VM name is given - VM to Host, VM to datastore etc., mapping is provided apiKey* - API Key to access your OpManager server.

name*- name of the device
http://localhost:8060/api/json/device/getVmwareEntityMapViewDetails?name=VMname.test.domain.com&apiKey=d1f24d53469be1a0a8acc6498e95e372
Dashboard
listCCTVView GET Lists all the CCTV views
apiKey* - API Key to access your OpManager server.
http://localhost:8060/api/json/dashboard/listCCTVView?apiKey=081c9ac51ba16ab061d5efee583dcd2f
getCCTVView GET Gets CCTV view widgets/dashboards
apiKey* - API Key to access your OpManager server.

cctvID* - cctv ID.
http://localhost:8060/api/json/dashboard/getCCTVView?apiKey=081c9ac51ba16ab061d5efee583dcd2f&cctvID=1
deleteCCTVView POST Deletes CCTV view
apiKey* - API Key to access your OpManager server.

cctvID* - cctv ID.
http://localhost:8060/api/json/dashboard/deleteCCTVView&cctvID=2&apiKey=081c9ac51ba16ab061d5efee583dcd2f
addCCTVView POST Add new CCTV view

dashboardId* - dashboard ID.

cctvName* - name of the cctv.

cctvDescription* - CCTV id

time* - refreshing time interval
 
http://localhost:8060/api/json/dashboard/addCCTVView?apiKey=081c9ac51ba16ab061d5efee583dcd2f&dashboardId=1&cctvName=testcctv&cctvDescription=newcctv&time=5
getDashBoardsForCCTV GET Get dashboards for the given CCTV view
apiKey* - API Key to access your OpManager server.

cctvID* - cctv ID.
http://localhost:8060/api/json/dashboard/getDashBoardsForCCTV?apiKey=081c9ac51ba16ab061d5efee583dcd2f&cctvID=1
deleteWidget POST Deletes the widget in dashboard page
apiKey* - API Key to access your OpManager server.

widgetID* - Widget ID
http://localhost:8060/api/json/dashboard/deleteWidget?apiKey=081c9ac51ba16ab061d5efee583dcd2f&widgetID=240
embedWidget POST Embeds URL of a widget
apiKey* - API Key to access your OpManager server.

regenerate* - true or 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* - API Key to access your OpManager server.
http://localhost:8060/api/json/dashboard/showWidgets?apiKey=081c9ac51ba16ab061d5efee583dcd2f
deleteDashboard POST Deletes a dashboard
apiKey* - API Key to access your OpManager server.

dashboardID* - dashboard ID.
http://localhost:8060/api/json/dashboard/deleteDashboard?apiKey=081c9ac51ba16ab061d5efee583dcd2f&dashboardID=7
updateDashboardLayout POST Updates dashboard layout
apiKey* - API Key to access your OpManager server.

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
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* - API Key to access your OpManager server.

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* - API Key to access your OpManager server.

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* - API Key to access your OpManager server.

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* - API Key to access your OpManager server.

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* - API Key to access your OpManager server.
http://localhost:8060/api/json/dashboard/getDashboardList?apiKey=081c9ac51ba16ab061d5efee583dcd2f
Credential Manager
addSNMPV3Credential POST Add new SNMP V3 credential

apiKey* - API Key to access your OpManager server.

port* – Protocol port number.

authPwd* - Credential username.

privPwd* – Credential password.

update – true or 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 Add new Vmware credential.

apiKey* - API Key to access your OpManager server.

username* - Username.

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

update* - true or false.

credentialName* - Credential name.

timeout* - Timeout value.

password* - Credential password.

port* - Credential port number
http://localhost:8060/api/json/admin/addVMWareCredential?apiKey=081c9ac51ba16ab061d5efee583dcd2f&username=root&autovmdiscovery=off&update=false&credentialName=vm&timeout=40&password=abc123&port=443
addLinuxCredential POST Adds a Linux credential
apiKey* - API Key to access your OpManager server.

update* - true or false.

pwpmt* - Prompt for password (true or false).

credentialName* - Credential name.

cmdpmt* - Command prompt (credentials).

protocol* - Protocol name.

username* - Username.

portno* - Port number.

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 Add new windows credential.
apiKey* - API Key to access your OpManager server.

credentialName* - Credential name.

username* - Username (domainname\username).

password* - Password.
http://localhost:8060/api/json/admin/addWindowsCredential?apiKey=081c9ac51ba16ab061d5efee583dcd2f
&credentialName=win&username=workgroup\administrator&password=Vembu123
addSNMPV1Credential POST Add new SNMP V1 credential.
apiKey* - API Key to access your OpManager server.

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 Lists all the workflows associated to a device. apiKey* - API Key to access your OpManager server. http://localhost:8060/api/json/workflow/getWorkflowList?apiKey=081c9ac51ba16ab061d5efee583dcd2f
* Mandatory parameters
** Mandatory if Auto-login is enabled.
 
CMDB Plugin API Beta.


REST API Method Description Parameters Sample URL
getCIList GET List 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 List 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 List 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 List all Purchases 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 List all Problems 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 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 Get Map details 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 Get child contract 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 Get purchase order 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 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 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

Actualizaciones de Servicio de Windows RestAPI:

 

REST API

Método

Descripción

Parámetros

URL de muestra

listActiveWindowsServices

POST

Muestra los Monitores de Servicio de Windows Activos

1. Usando la Contraseña Asociada:
apiKey* - Clave API para acceder a su servidor OpManager.

 

deviceName* - Nombre del dispositivo

SelectedCredential * – associatedPassword (como valor codificado fijo)

2. Usando el nombre de la credencial :
apiKey *
- Clave API para acceder a su servidor OpManager.

deviceName *
- Nombre del dispositivo

Credential *
- Nombre de la credencial WMI

SelectedCredential *
- credentialSelected (como valor codificado fijo)

1. Usando la Contraseña Asociada:
API:
http://localhost:8060/api/json/admin/listActiveWindowsServices

Parámetros POST:
apiKey:081c9ac51ba16ab061d5efee583dcd2f
deviceName:nfa-2k12r2-2.csez.zohocorpin.com
selectedCredential:associatedPassword

 

2. Usando el nombre de la credencial :
API:
http://localhost:8060/api/json/admin/listActiveWindowsServices

Parámetros POST:
apiKey:081c9ac51ba16ab061d5efee583dcd2f
deviceName:nfa-2k12r2-2.csez.zohocorpin.com
credential:WMIDevices
selectedCredential:credentialSelected

getWindowsServiceMonitor

GET

Recibe información de Monitor de Servicio de Windows

apiKey * - Clave API para acceder a su servidor OpManager.

 

serviceID * - Identificación de servicio de Servicio de Windows

NOTA :
Recibe serviceID de Windows usando Consulta de BD
1. seleccione id como " ServiceID ",Nombre como "DisplayName",ServiceName de NTServicesDefinition donde Name='ReplaceDisplayNameHere' y ServiceName='ReplaceServiecNameHere'
O usando la siguiente consulta

2. seleccione id como " ServiceID ",Nombre como "DisplayName",ServiceName de NTServicesDefinition

http://localhost:8060/api/json/admin/getWindowsServiceMonitor?apiKey=081c9ac51ba16ab061d5efee583dcd2f&serviceID=301

deleteWindowsServiceMonitor

POST

Elimina Monitor de Servicio de Windows

apiKey * - Clave API para acceder a su servidor OpManager.

 

serviceID * - Identificación de servicio de Servicio de Windows

NOTA:
Recibe serviceID de Windows usando Consulta de BD
1. seleccione id como " ServiceID ",Nombre como "DisplayName",ServiceName de NTServicesDefinition donde Name='ReplaceDisplayNameHere' y ServiceName='ReplaceServiecNameHere'
O usando la siguiente consulta
2. seleccione id como " ServiceID ",Nombre como "DisplayName",ServiceName de NTServicesDefinition

API:
http://localhost:8060/api/json/admin/deleteWindowsServiceMonitor

 

Parámetros POST:
apiKey:081c9ac51ba16ab061d5efee583dcd2f
serviceID:23232

updateWindowsServiceMonitor

POST

Actualiza información de Monitor de Servicio de Windows

apiKey * - Clave API para acceder a su servidor OpManager.

 

serviceID * - Identificación de servicio de Servicio de Windows

failureThreshold * - Valor de tiempos consecutivos a actualizar

actionType * - Tipo de acción a actualizar. Cualquiera entre 0/1/2, 0 - No hay acción, 1 - Reiniciar el servicio, 2 - Reiniciar el servidor

NOTE:
Recibe serviceID de Windows usando Consulta de BD
1. seleccione id como " ServiceID ",Nombre como "DisplayName",ServiceName de NTServicesDefinition donde Name='ReplaceDisplayNameHere' y ServiceName='ReplaceServiecNameHere'
O usando la siguiente consulta
2. seleccione id como " ServiceID ",Nombre como "DisplayName",ServiceName de NTServicesDefinition

API:
http://localhost:8060/api/json/admin/updateWindowsServiceMonitor

Parámetros POST:
apiKey:081c9ac51ba16ab061d5efee583dcd2f
serviceID:2
failureThreshold:3
ActionType:1

addNTServiceMonitors

POST

Agrega Servicios de Windows

1. Agrega nuevos Servicios de Windows:
apiKey * - Clave API para acceder a su servidor OpManager.

 

name * - Nombre del dispositivo.

discoverFromDevice – verdadero o falso.

displayNames – Mostrar nombres de servicio en JSONArray o en formato separado por comas.

serviceNames – Nombres de servicio en JSONArray o en formato separado por comas

2. Asigna Servicios de Windows a dispositivos:
apiKey * - Clave API para acceder a su servidor OpManager.

name * - Nombre del dispositivo.

assignedNTServices – servicesID seleccionados en JSONArray (aplicable sólo cuando 'descubrir desde el dispositivo' se establece como falso o nulo)

discoverFromDevice – falso

IsAdminPage : verdadero

1. Agrega Nuevo Servicios de Windows:
API:
http://localhost:8060/api/json/device/addNTServiceMonitors
Parámetros POST:
apiKey:081c9ac51ba16ab061d5efee583dcd2f
name:raj-3515.csez.zohocorpin.com
serviceNames:["DDVDataCollector","Netman","WavesSysSvc","AxInstSV"]
displayNames:["Dell Data Vault Collector","Network Connections","Waves Audio Services","ActiveX Installer (AxInstSV)"]
discoverFromDevice:true ↵

 

2. Asigna Servicios de Windows a dispositivos:
API:
http://localhost:8060/api/json/device/addNTServiceMonitors
Parámetros POST:
name: opm-dev1.csez.zohocorpin.com,opm-dev2.csez.zohocorpin.com,nfa-2k12r2-2.csez.zohocorpin.com
discoverFromDevice: false
assignedNTServices: ["19","16","17"]
isAdminPage: true