# REST API de OpManager OpManager ofrece las REST API para agregar y buscar datos de OpManager. Usando estas API, puedes [integrar OpManager](https://www.manageengine.com/latam/network-monitoring/complementos-plugins-integraciones.html) con software de administración de TI/mesa de servicio de terceros. ![REST API - ManageEngine OpManager](https://www.manageengine.com/network-monitoring/help/images/rest-api-opmanager-1.png) ## ¿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 | 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. | ## Identificación de criterios | 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, 3, 5 o a; 1 para seleccionar 1 sondeo, 3 para seleccionar 3 sondeos, 5 para seleccionar 5 sondeos o a para seleccionar 1, 3 y 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 #### Módulo de Administrador | REST API | Método | Descripción | Parámetros | URL de muestra | |---|---|---|---|---| | **addServiceMonitor** | POST | Agregar monitor de servicio | **apiKey***: clave API; **serviceName***: nombre del servicio; **portNumber***: puerto; **timeOut**: tiempo de espera en segundos, valor predeterminado 0; **failureThreshold**: valor consecutivo para alerta, valor predeterminado 1; **autoDiscovery**: verdadero o falso. | https://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; **destHost***: host de destino; **destPort***: puerto de destino, entre 0 y 65536. | https://localhost:8060/api/json/admin/addSysLogForwarder?apiKey=081c9ac51ba16ab061d5efee583dcd2f&destHost=opman-k8r2s-64-3&destPort=515 | | **addSysLogRule** | POST | Agrega Regla SysLog | **apiKey***, **ruleName***, **facilityName***, **severityList***, **alertSeverity***, **alarmMessage***, **matchString**, **consecutiveTime***, **timeInterval***, **rearmFacilityName**, **rearmSeverityList**, **rearmMatchString**. | https://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; **destHost***: host de destino; **destPort***: puerto de destino. | https://localhost:8060/api/json/admin/addTrapForwarder?apiKey=081c9ac51ba16ab061d5efee583dcd2f&destHost=opman-k8r2s-64-6&destPort=165 | | **deleteCredential** | POST | Eliminar credenciales | **apiKey***: clave API; **credentialName***: nombre de la credencial; **isSNMPV3**: verdadero o falso. | https://localhost:8060/api/json/admin/deleteCredential?apiKey=081c9ac51ba16ab061d5efee583dcd2f&credentialName=Public | | **deleteServiceMonitor** | POST | Eliminar monitor de servicio | **apiKey***: clave API; **serviceName***: nombre del servicio. | https://localhost:8060/api/json/admin/deleteServiceMonitor?apiKey=081c9ac51ba16ab061d5efee583dcd2f&serviceName=test2 | | **getCredentialDetails** | GET | Recibir información de credenciales | **apiKey***: clave API; **credentialName***: nombre de la credencial; **type***: tipo de dispositivo, por ejemplo Windows, Linux, SNMP v1/v2, SNMP v3 o VMware. | https://localhost:8060/api/json/admin/getCredentialDetails?apiKey=081c9ac51ba16ab061d5efee583dcd2f&credentialName=Public&type=SNMP%20v1/v2 | | **getDBMaintenanceData** | GET | Proporciona la configuración de mantenimiento de la BD | **apiKey***: clave API. | https://localhost:8060/api/json/admin/getDBMaintenanceData?apiKey=081c9ac51ba16ab061d5efee583dcd2f | | **getFlowRate** | GET | Recibir velocidad de flujo de SysLog | **apiKey***: clave API. | https://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. | https://localhost:8060/api/json/admin/getSystemSettingsDetails?apiKey=081c9ac51ba16ab061d5efee583dcd2f | | **setDBMaintenanceData** | POST | Permite configurar el mantenimiento de la BD | **apiKey***: clave API; **alarmscount**: recuento de alarmas; **rawdata**: estadísticas detalladas; **hourlydata**: estadísticas por hora; **dailydata**: estadísticas diarias. | https://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***, **serviceName***, **timeOut***, **failureThreshold*** y **autoDiscovery***. | https://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***, **ALARMMESSAGELENGTH**, **CLILOG**, **DATACOLLECTIONRATE**, **DEBUGPRINTS**, **POLLPERSECOND**, **SCHEDULERRATE**, **SNMPLOG**, **SNMPV3LOG**, **ShowAds**, **WMILOG**, **benchmarkupload**, **metrackupload**, **quicklinks**. | https://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; **pluginName***: nombre del plugin; **eventTime***: período de generación del evento. Para todos los eventos, use `All`. | https://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; **fromTime***: hora inicial; **toTime***: hora final. | https://localhost:8060/api/json/alarm/getPluginEventCount?apiKey=6d36ff8426cff396b81b248e5c458604&fromTime=2014-2-20%2013:32:8&toTime=2014-2-20%2014:2:8 | | **getPluginDetails** | GET | Busca información de los plugins instalados | **apiKey***: clave API. | https://localhost:8060/api/json/admin/getPluginDetails?apiKey=081c9ac51ba16ab061d5efee583dcd2f | | **getDeviceListForTestScript** | GET | Lista de dispositivos para el script de prueba | **apiKey***: clave API; **executedFrom***: nombre del dispositivo ejecutado, por ejemplo `Local Server`. | https://localhost:8060/api/json/admin/getDeviceListForTestScript?apiKey=081c9ac51ba16ab061d5efee583dcd2f&executeFrom=Local%20Server | | **upadateTrapParser** | POST | Actualizar el analizador de trampas | **apiKey***, **version***, **oid*** y **TrapParserName***. | https://localhost:8060/api/json/admin/upadateTrapParser?apiKey=081c9ac51ba16ab061d5efee583dcd2f&version=v2&oid='.<ip_address_1>.2.'&trapParserName=testing | | **updateLanguageSettings** | POST | Actualizar la configuración del idioma | **apiKey***: clave API; **languageSelected***: idioma seleccionado. | https://localhost:8060/api/json/admin/updateLanguageSettings?apiKey=6d36ff8426cff396b81b248e5c458604&languageSelected=fr_FR | | **getLanguageSettings** | GET | Obtains language settings. | **apiKey***: API Key to access your OpManager server. | https://localhost:8060/api/json/admin/getLanguageSettings?apiKey=1d626117b2ac31145ce6bca49bb0458b | | **triggerWorkflow** | POST | Allows to trigger a workflow on a device. | **apiKey***: API Key; **workflowName***: workflow name; **deviceName***: device name. | https://localhost:8060/api/json/workflow/triggerWorkflow?apiKey=081c9ac51ba16ab061d5efee583dcd2f&deviceName=opman-k8r2s-64-3.testdomain.com&workflowName=Instant%20Device%20Check | | **deleteAgentDetails** | POST | Delete agent devices | **apiKey***: API Key; **selectedDevices***: devices for deletion. | https://localhost:8060/api/json/admin/deleteAgentDetails?selectedDevices=1392094715&apiKey=6d36ff8426cff396b81b248e5c458604 | | **updateAgentDetails** | POST | Update agent device details | **apiKey***: API Key; **agentKey***: MonitoringAgent Key; **mappedDevice***: mapped device name. | https://localhost:8060/api/json/admin/updateAgentDetails?agentKey=1392094715&apiKey=6d36ff8426cff396b81b248e5c458604&mappedDevice=640 | | **showAgentDetails** | GET | Shows the installed agent details | **apiKey***: API Key. | https://localhost:8060/api/json/admin/showAgentDetails?apiKey=6d36ff8426cff396b81b248e5c458604 | | **deleteFailOverDetails** | POST | Deletes the fail-over server details | **apiKey***: API Key. | https://localhost:8070/api/json/admin/deleteFailOverDetails?apiKey=6d36ff8426cff396b81b248e5c458604 | | **updateFailOverDetails** | POST | Updates fail-over server details | **apiKey***: API Key. | https://localhost:8070/api/json/admin/updateFailOverDetails?apiKey=6d36ff8426cff396b81b248e5c458604 | | **listFailOverDetails** | GET | Lists the fail-over server details | **apiKey***: API Key; **serviceName***: failover device name. | https://localhost:8060/api/json/admin/listFailOverDetails?serviceName=DNS&apiKey=081c9ac51ba16ab061d5efee583dcd2f | | **registerLicense** | POST | Registers the license file | **apiKey***: API Key; **fileName***: license file name. | https://localhost:8060/api/json/admin/registerLicense?apiKey=6d36ff8426cff396b81b248e5c458604 | | **licenseDetails** | GET | Fetches license details | **apiKey***: API Key. | https://localhost:8060/api/json/admin/licenseDetails?apiKey=081c9ac51ba16ab061d5efee583dcd2f | | **getCredentialMappedDevices** | GET | Lists devices mapped to the given credential | **apiKey***: API Key; **credentialName***: credential name. | https://localhost:8060/api/json/admin/getCredentialMappedDevices?apiKey=081c9ac51ba16ab061d5efee583dcd2f&credentialName=Public | | **sendSIF** | POST | Sends support information file | **apiKey***, **customerName***, **phone***, **subject***, **userMessage***, **fromAddress*** y **supportFile***. | https://localhost:8060/api/json/admin/sendSIF?apiKey=6d36ff8426cff396b81b248e5c458604&customerName=administrator@opmanager.com&phone=7781&subject=OpmLogs&userMessage=opm%20logs%20for%20analyzing%20issue&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. | https://localhost:8060/api/json/admin/createSIF?apiKey=081c9ac51ba16ab061d5efee583dcd2f | | **viewLogs** | GET | Lists all the OpManager logs | **apiKey***: API Key. | https://localhost:8060/api/json/admin/viewLogs?apiKey=081c9ac51ba16ab061d5efee583dcd2f | | **updateJvmHeapSize** | POST | Updates JVM Heap size | **apiKey***: API Key; **jvmHeapSize***: New JVM Heap size. | https://localhost:8060/api/json/admin/updateJvmHeapSize?apiKey=6d36ff8426cff396b81b248e5c458604&JvmHeapSize=5120 | | **generateHeapDump** | POST | Generates Heap dump file | **apiKey***: API Key. | https://localhost:8060/api/json/admin/generateHeapDump?apiKey=081c9ac51ba16ab061d5efee583dcd2f | | **GetThreadDump** | GET | Fetches thread dump. | **apiKey***: API Key. | https://localhost:8060/api/json/admin/GetThreadDump?apiKey=83155f195334a19df5e58a8a33a6f804 | | **GetSystemInformation** | GET | Obtains System information. | **apiKey***: API Key. | https://localhost:8060/api/json/admin/GetSystemInformation?apiKey=081c9ac51ba16ab061d5efee583dcd2f | | **getProcessTemplateAssociatedDevices** | GET | Fetch the Process templates associated devices. | **apiKey***: API Key; **protocol***: protocol type; **templateID***: template or process ID. | https://localhost:8060/api/json/admin/getProcessTemplateAssociatedDevices?apiKey=1d626117b2ac31145ce6bca49bb0458b&protocol=WMI&templateID=2 | | **GetRebrandDetails** | GET | Fetches the rebrand details. | **apiKey***: API Key; **alarmscount***, **rawdata*** y **hourlydata***. | https://localhost:8060/api/json/admin/GetRebrandDetails?apiKey=081c9ac51ba16ab061d5efee583dcd2f&alarmscount=10000&rawdata=7&hourlydata=30 | | **rebrandOpManager** | GET | Rebrands the product. | **apiKey***: API Key; **productName***: rebranded product name. | https://localhost:8060/api/json/admin/rebrandOpManager?apiKey=6d36ff8426cff396b81b248e5c458604&productName=ServerMonitoringTool | | **regenerateAPIKey** | GET | Regenerates API Key | **apiKey***: API Key. | https://localhost:8060/api/json/admin/regenerateAPIKey?apiKey=081c9ac51ba16ab061d5efee583dcd2f | | **getActualScheduleRate** | GET | Gets actual schedule rate | **apiKey***: API Key; **fromTime***: inicio de la recopilación; **toTime***: final de la recopilación. | https://localhost:8060/api/json/diagnostics/getActualScheduleRate?apiKey=081c9ac51ba16ab061d5efee583dcd2f&fromTime=2013-12-21%2000:01:15&toTime=2013-12-21%2023:59:15 | | **deleteDomain** | POST | Deletes the domain name. | **apiKey***: API Key; **domainName***: domain name. | https://localhost:8060/api/json/admin/deleteDomain?apiKey=081c9ac51ba16ab061d5efee583dcd2f&domainName=ZOHOCORP | | **addUrl** | POST | Add new URL monitor | **apiKey***, **pollInterval***, **failureThreshold***, **errorContent***, **urlName***, **password***, **url***, **cookie***, **queryString**, **deviceName***, **matchContent**, **userName**, **method***, **timeout*** y **update***. | https://localhost:8060/api/json/admin/addUrl?apiKey=5070623c57db770f93ca914dc7b598f8&pollInterval=5&failureThreshold=1&errorContent=&urlName=test&password=&url=https://test&cookie=ACCEPT&queryString=&deviceName=undefined&matchContent=&userName=&method=G&timeout=25&update=false | #### Alarm Escalation | REST API | Método | Descripción | Parámetros | URL de muestra | |---|---|---|---|---| | **addAlarmEscalationRules** | POST | Add Alarm Escalation rules | **apiKey***, **rulename***, **interval***, **alarmlife***, **units***, **severity***, **category***, **notificationType***. Para SMS: **number**, **smsMessage**. Para EMAIL: **fromemailid**, **toemailid**, **subject**, **message**. | https://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***: nombres de reglas separados por comas. | https://localhost:8060/api/json/admin/deleteAlarmEscalationRules?apiKey=081c9ac51ba16ab061d5efee583dcd2f&rulename=test2 | | **showEscalationRules** | GET | Provides all Alarm Escalation rules available. | **apiKey***: API key. | https://localhost:8060/api/json/admin/showEscalationRules?apiKey=081c9ac51ba16ab061d5efee583dcd2f | | **updateAlarmEscalationRules** | POST | Updates the Alarm Escalation Rule. | **apiKey***, **rulename***, **interval***, **alarmlife***, **units***, **severity***, **category***, **notificationType***. | https://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¬ificationType=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; **rulename***: rule name. | https://localhost:8060/api/json/admin/viewAlarmEscalationRules?apiKey=081c9ac51ba16ab061d5efee583dcd2f&rulename=test2 | #### Alerts | REST API | Método | Descripción | Parámetros | URL de muestra | |---|---|---|---|---| | **acknowledgeAlarm** | POST | Allows to acknowledge an alarm. | **apiKey***: API Key; **entity**: entidad de la alarma. | https://localhost:8060/api/json/alarm/acknowledgeAlarm?apiKey=081c9ac51ba16ab061d5efee583dcd2f&entity=222222222 | | **addEvent** | POST | Adds an event. | **apiKey***, **source***, **severity***, **message***, **alarmCode**, **entity**, **eventType**. Severidades: Critical 1, Trouble 2, Attention 3, Service Down 4. | https://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***, **entity*** y **notes***. | https://localhost:8060/api/json/alarm/addNotes?apiKey=081c9ac51ba16ab061d5efee583dcd2f¬es=test&entity=222222222 | | **alarmProperties** | GET | Provides the details of an alarm, for example status and acknowledgement | **apiKey***: API Key; **entity***: entidad de la alarma. | https://localhost:8060/api/json/alarm/alarmProperties?apiKey=081c9ac51ba16ab061d5efee583dcd2f&entity=222222222 | | **clearAlarm** | POST | Clears an alarm. | **apiKey***: API Key; **entity***: entidad de la alarma. | https://localhost:8060/api/json/alarm/clearAlarm?apiKey=081c9ac51ba16ab061d5efee583dcd2f&entity=222222222 | | **deleteAlarm** | POST | Deletes an alarm. | **apiKey***: API Key; **entity***: entidad de la alarma. | https://localhost:8060/api/json/alarm/deleteAlarm?apiKey=081c9ac51ba16ab061d5efee583dcd2f&entity=222222222 | | **getAnnotation** | GET | Provides the notes available for an alarm. | **apiKey***: API Key; **entity***: entidad de la alarma. | https://localhost:8060/api/json/alarm/getAnnotation?apiKey=081c9ac51ba16ab061d5efee583dcd2f&entity=222222222 | | **getTopDevicesByAlarms** | GET | Provides the list of top devices by alarms count. | **apiKey***: API Key; **eventType***: tipo del evento. | https://localhost:8060/api/json/alarm/getTopDevicesByAlarms?apiKey=081c9ac51ba16ab061d5efee583dcd2f&eventType=THRESHOLD-DOWN | | **getTopDevicesByEvents** | GET | Lists the top devices by events count. | **apiKey***: API Key; **eventType***: tipo del evento. | https://localhost:8060/api/json/events/getTopDevicesByEvents?apiKey=081c9ac51ba16ab061d5efee583dcd2f&eventType=THRESHOLD-DOWN | | **listAlarmEscalationRules** | GET | Lists all the alarm escalation rules created. | **apiKey***: API Key. | https://localhost:8060/api/json/admin/listAlarmEscalationRules?apiKey=081c9ac51ba16ab061d5efee583dcd2f | | **listAlarms** | GET | List all the alarms available. | **apiKey***; filtros opcionales: **deviceName**, **severity**, **Category**, **fromTime**, **toTime**. Severidades: Critical 1, Trouble 2, Attention 3, Service Down 4. | https://localhost:8060/api/json/alarm/listAlarms?apiKey=081c9ac51ba16ab061d5efee583dcd2f&Category=Server&deviceName=opman-k8r2s-64-3..testdomain.com&severity=1&toTime=2014-02-12%2023:59:00&fromTime=2014-02-12%2000:01:01 | | **listNotificationProfiles** | GET | Lists all the notification profiles created in OpManager. | **apiKey***; **profileFilter** y **isGlobal** son opcionales. | https://localhost:8060/api/json/admin/listNotificationProfiles?apiKey=641dc197c94dcabb6af38c64352e5954&isFluidic=true&profileFilter=All | | **associateNotificationProfiles** | POST | Associate Notification Profiles | **apiKey***, **profiles***: ProfileID; **deviceName***: dispositivos asociados. | https://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; **entity**: entidad de la alarma. | https://localhost:8060/api/json/alarm/unAcknowledgeAlarm?apiKey=081c9ac51ba16ab061d5efee583dcd2f&entity=222222222 | | **getAlarmList** | GET | Lists all the alarms irrespective of the device/category | **apiKey***: API Key. | https://localhost:8060/api/json/alarm/getAlarmList?apiKey=081c9ac51ba16ab061d5efee583dcd2f | | **listEvents** | GET | Lists all generated events | **apiKey***: API Key. | https://localhost:8060/api/json/events/listEvents?apiKey=6d36ff8426cff396b81b248e5c458604 | #### Device discovery | REST API | Método | Descripción | Parámetros | URL de muestra | |---|---|---|---|---| | **addDevice** | POST | Add a device. | **apiKey***, **deviceName***, **netmask**, **credentialName**, **type**, **displayName**. | https://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=<ip_address_2>&type=Windows%202008%20R2 | | **addDeviceToGMap** | POST | Adds devices to Google map. | **apiKey***, **deviceName***, **latitude*** y **longitude***. | https://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***, **domainName**, **domainController**, **autoLogin**, **loginType**, **privilege**, **readOnlyGroups**, **fullControlGroups**. | https://localhost:8060/api/json/admin/addDomain?apiKey=081c9ac51ba16ab061d5efee583dcd2f&domainController=win2k8master.testdomain.com&autoLogin=true&loginType=All%20Users&domainName=testdomain | | **deleteDevice** | POST | Deletes a device. | **apiKey***: API Key; **deviceName***: dispositivo que se eliminará. | https://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; **domainName**: nombre del dominio. | https://localhost:8060/api/json/admin/deleteDomain?apiKey=081c9ac51ba16ab061d5efee583dcd2f&domainName=ZOHOCORP | | **listCredentials** | GET | Gives the list of credentials created in OpManager. | **apiKey***: API Key. | https://localhost:8060/api/json/admin/listCredentials?apiKey=081c9ac51ba16ab061d5efee583dcd2f | | **listDownTimeSchedules** | GET | Gives the list of downtime schedules created. | **apiKey***: API Key. | https://localhost:8060/api/json/admin/listDownTimeSchedules?apiKey=83155f195334a19df5e58a8a33a6f804 | | **RediscoverDevice** | POST | Rediscovers a device | **apiKey***, **name*** y **snmpCredentialNames***. | https://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; **deviceName***: dispositivo. | https://localhost:8060/api/json/discovery/reDiscoverInterfaces?deviceName=opman-k8r2s-64-3.testdomain.com&apiKey=081c9ac51ba16ab061d5efee583dcd2f | | **doSearch** | GET | Search a device/interface | **apiKey***, **type*** y **searchString***. | https://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; **deviceName***: nombre del dispositivo. | https://localhost:8060/api/json/discovery/searchDevice?apiKey=081c9ac51ba16ab061d5efee583dcd2f&deviceName=opman-k8r2s-64-3.testdomain.com | #### Interface discovery | REST API | Método | Descripción | Parámetros | URL de muestra | |---|---|---|---|---| | **discoverInterface** | POST | Discovers an interface. | **apiKey***, **devicesList***, **intftypes***, **adminStates*** y **operStates***. | https://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; **name***: nombre del dispositivo. | https://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; **interfaceName**: nombre de la interfaz. | https://localhost:8060/api/json/device/getInterfaceSummary?apiKey=83155f195334a19df5e58a8a33a6f804&interfaceName=IF-opman-k8r2s-64-3.testdomain.com-4505 | #### Inventory | REST API | Método | Descripción | Parámetros | URL de muestra | |---|---|---|---|---| | **getInterfaceTypes** | GET | Provides the type of interface, for example serial or ethernet. | **apiKey***: API Key. | https://localhost:8060/api/json/device/getInterfaceTypes?apiKey=081c9ac51ba16ab061d5efee583dcd2f | | **getProbeURL** | GET | Provides the URL of the probe. | **apiKey***: API Key; **name**: nombre del dispositivo. | https://localhost/api/json/device/addNotesToDevice?apiKey=ac130763a309fcb1613e0b8a551950a2&name=localhost.testdomain.com | | **listVirtualDevices** | GET | Lists all the available virtual devices | **apiKey***: API Key; **virtualDeviceType***: tipo de dispositivo virtual. | https://localhost:8060/api/json/device/listVirtualDevices?virtualDeviceType=VM&apiKey=1d626117b2ac31145ce6bca49bb0458b | | **fetchInterfacesList** | GET | Fetches all interfaces of the given device and category | **apiKey***, **username***, **category*** y **deviceList***. | https://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***, **username*** y **category***. | https://localhost:8060/api/json/device/fetchDevicesList?apiKey=081c9ac51ba16ab061d5efee583dcd2f&username=admin&category=Server | | **listDevices** | GET | Lists all the devices added in OpManager. | **apiKey***; filtros opcionales: **deviceName**, **type** y **Category**. | https://localhost:8060/api/json/device/listDevices?apiKey=081c9ac51ba16ab061d5efee583dcd2f&Category=Server&deviceName=opman-k8r2s-64-3.testdomain.com&type=Windows%202008%20R2 | | **listInterfaces** | GET | Lists all the interfaces in OpManager. | **apiKey***: API Key. | https://localhost:8060/api/json/device/listInterfaces?apiKey=83155f195334a19df5e58a8a33a6f804 | | **getDevicePackageList** | GET | Lists device package | **apiKey***: API Key. | https://localhost:8060/api/json/device/getDevicePackageList?apiKey=081c9ac51ba16ab061d5efee583dcd2f | | **getCategoryList** | GET | Lists all the available device categories | **apiKey***: API Key. | https://localhost:8060/api/json/device/getCategoryList?apiKey=081c9ac51ba16ab061d5efee583dcd2f | | **getVendorList** | GET | Lists all the vendors | **apiKey***: API Key. | https://localhost:8060/api/json/device/getVendorList?apiKey=081c9ac51ba16ab061d5efee583dcd2f | #### Layer2 discovery | REST API | Método | Descripción | Parámetros | URL de muestra | |---|---|---|---|---| | **addLayer2Map** | POST | Adds a Layer2 devices Map | **apiKey***, **mapName***, **seedDevice***, **startAddr***, **endAddr***, **subnetMask***, **credentialName***, **scheduleInterval*** y **discoverNow***. | https://localhost:8060/api/json/discovery/addLayer2Map?apiKey=081c9ac51ba16ab061d5efee583dcd2f&credentialName=Public&seedDevice=<ip_address_6>&startAddr=<ip_address_6>&mapName=Testmap&endAddr=192.168.50.130&discoverNow=true&scheduleInterval=5 | | **deleteLayer2Map** | POST | Allows to delete Layer2 map. | **apiKey***: API Key; **mapName***: nombre del mapa. | https://localhost:8060/api/json/discovery/deleteLayer2Map?apiKey=081c9ac51ba16ab061d5efee583dcd2f&mapName=Testmap | | **discoverLayer2Devices** | POST | Discovers Layer2 devices | **apiKey***: API Key; **deviceNames***: dispositivos separados por comas. | https://localhost/api/json/discovery/discoverLayer2Devices?apiKey=ac130763a309fcb1613e0b8a551950a2&deviceNames=<ip_address_6>,192.168.50.130 | | **discoverLayer2Map** | POST | Discovers Layer2 Map | **apiKey***: API Key; **mapName***: mapa que se descubre o actualiza. | https://localhost:8060/api/json/discovery/discoverLayer2Map?apiKey=081c9ac51ba16ab061d5efee583dcd2f&mapName=TestMap | | **getDiscoveredLayer2Map** | GET | Allows you to view the discovered Layer2 Map | **apiKey***: API Key; **mapName***: mapa que se muestra. | https://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. | https://localhost:8060/api/json/maps/getLayer2ScanDetails?apiKey=5022357be4231edff71ed25cf960457a | | **getLayer2Maps** | GET | Lists all the Layer2 Maps available in Opmanager | **apiKey***: API Key. | https://localhost:8060/api/json/maps/getLayer2Maps?apiKey=081c9ac51ba16ab061d5efee583dcd2f | #### Mail Server Settings | REST API | Método | Descripción | Parámetros | URL de muestra | |---|---|---|---|---| | **GetMailServerSettings** | GET | Provides the details of mail server settings. | **apiKey***: API Key. | https://localhost:8060/api/json/admin/GetMailServerSettings?apiKey=081c9ac51ba16ab061d5efee583dcd2f | | **getMailVariables** | GET | Get send mail parameters | **apiKey***: API Key. | https://localhost:8060/api/json/admin/getMailVariables?apiKey=081c9ac51ba16ab061d5efee583dcd2f | #### Maps | REST API | Método | Descripción | Parámetros | URL de muestra | |---|---|---|---|---| | **addBusinessView** | POST | Adds a new business view. | **apiKey***: API Key; **bvName***: nombre del Business View. | https://localhost:8060/api/json/discovery/addBusinessView?apiKey=081c9ac51ba16ab061d5efee583dcd2f&bvName=test | | **addDeviceToBV** | POST | Adds devices to a Business View that is already created. | **apiKey***, **deviceName*** y **bvName***. | https://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***, **bvName***, **viewLength** y **startPoint**. | https://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. | https://localhost:8060/api/json/businessview/getBusinessView?apiKey=081c9ac51ba16ab061d5efee583dcd2f | | **getFloorDetails** | GET | Provides the details of floor, for example floor size and tile size. | **apiKey***: API Key; **floorId***: ID de piso. | https://localhost:8060/api/json/maps/getFloorDetails?apiKey=83155f195334a19df5e58a8a33a6f804&floorId=1 | | **getInfrastructureView** | GET | Provides the details of a particular infrastructure type, for example servers. | **apiKey***: API Key. | https://localhost:8060/api/json/discovery/getInfrastructureView?apiKey=081c9ac51ba16ab061d5efee583dcd2f | | **listFloors** | GET | Lists all the floors created. | **apiKey***: API Key. | https://localhost:8060/api/json/maps/listFloors?apiKey=1d626117b2ac31145ce6bca49bb0458b | | **listRacks** | GET | Lists all the racks created. | **apiKey***: API Key. | https://localhost:8060/api/json/maps/listRacks?apiKey=83155f195334a19df5e58a8a33a6f804 | | **getUsersAssociatedToBV** | GET | Displays all the users associated to the given business view | **apiKey***: API Key; **BvName***: nombre del Business View. | https://localhost:8060/api/json/businessview/getUsersAssociatedToBV?apiKey=83155f195334a19df5e58a8a33a6f804&bvName=test | | **getBVDetails** | GET | Fetches information of the given BusinessView | **apiKey***, **BvName*** y **viewId***. | https://localhost:8060/api/json/businessview/getBVDetails?apiKey=081c9ac51ba16ab061d5efee583dcd2f&viewId=1&bvName=test | #### Proxy Server Settings | REST API | Método | Descripción | Parámetros | URL de muestra | |---|---|---|---|---| | **GetProxyServerSettings** | GET | Provides the details of proxy server settings. | **apiKey***: API Key. | https://localhost:8060/api/json/admin/GetProxyServerSettings?apiKey=081c9ac51ba16ab061d5efee583dcd2f | #### SMS Server Settings | REST API | Método | Descripción | Parámetros | URL de muestra | |---|---|---|---|---| | **configureSMSServerSettings** | POST | Allows to configure the SMS server settings. | **apiKey***: API Key; **portno***: puerto, por ejemplo COM1; **mobileno***: número móvil. | https://localhost:8060/api/json/admin/configureSMSServerSettings?apiKey=081c9ac51ba16ab061d5efee583dcd2f&mobileno=9840833757&portno=COM21 | | **GetSMSServerSettings** | GET | Provides the details of SMS server settings. | **apiKey***: API Key. | https://localhost:8060/api/json/admin/GetSMSServerSettings?apiKey=081c9ac51ba16ab061d5efee583dcd2f | #### User Management | REST API | Método | Descripción | Parámetros | URL de muestra | |---|---|---|---|---| | **addUser** | POST | Adds an user in OpManager. | **apiKey***, **userName***, **password***, **privilege***, **bvName**, **emailId**, **landLine**, **mobileNo** y **domainName**. Privilegios: Administrators para acceso total; Operators para acceso restringido. | https://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***, **userName***, **userId***, **domainName**, **oldPassword*** y **newPassword***. | https://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; **userName***: nombre de usuario. | https://localhost:8060/api/json/admin/deleteUser?apiKey=081c9ac51ba16ab061d5efee583dcd2f&userName=rejoe@testdomain.com | | **listUsers** | GET | Lists all users created in OpManager. | **apiKey***: API Key. | https://localhost:8060/api/json/admin/listUsers?apiKey=081c9ac51ba16ab061d5efee583dcd2f | | **updateContactDetails** | POST | Allows you to update the contact details of a user. | **apiKey***, **userName***, **userId***, **domainName**, **emailId***, **phoneNumber** y **mobileNumber**. | https://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 | REST API | Método | Descripción | Parámetros | URL de muestra | |---|---|---|---|---| | **getVMWareDataStores** | GET | Provides details of all available datastores, including Datastore ID, name and capacity in MB. | **name***: nombre del vCenter; **type**: VCENTER, HOST o VM. | https://localhost:8060/client/api/json/device/getVMWareDataStores?name=vcenter.test.domain.com&type=VCENTER | | **getVMWareHosts** | GET | Provides details of available hosts, including hostname, memory, OS type and CPU speed. | **name***: nombre del vCenter. | https://localhost:8060/client/api/json/device/getVMWareHosts?name=vcenter.test.domain.com | | **getVMWareVMs** | GET | Provides details of VMware Virtual Machines. | **name***: vCenter, host o datastore; **type**: VCENTER, HOST o DATASTORE. | https://localhost:8060/client/api/json/device/getVMWareVMs?name=vcenter.test.domain.com&type=VCENTER | | **getVmwareEntityMapViewDetails** | GET | Provides mapping details for the specified device. | **apiKey***: API Key; **name***: nombre del dispositivo. | https://localhost:8060/api/json/device/getVmwareEntityMapViewDetails?name=VMname.test.domain.com&apiKey=d1f24d53469be1a0a8acc6498e95e372 | #### WorkFlow | REST API | Método | Descripción | Parámetros | URL de muestra | |---|---|---|---|---| | **getWorkflowList** | GET | Lists all the workflows associated to a device. | **apiKey***: API Key. | https://localhost:8060/api/json/workflow/getWorkflowList?apiKey=081c9ac51ba16ab061d5efee583dcd2f | \* Parámetros obligatorios. \*\* Obligatorio si Auto-login está habilitado. ## CMDB Plugin API Beta | REST API | Método | Descripción | Parámetros | URL de muestra | |---|---|---|---|---| | getCIList | GET | List all configuration item | **TECHNICIAN_KEY***: API Key to access server. | https://<ip_address_8>:8080/sdplus/CMDB/getCIList?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97 | | getAllChanges | GET | List all Changes | **TECHNICIAN_KEY***: API Key to access server. | https://<ip_address_8>:8080/sdplus/Change/getAllChanges?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97 | | getAllContracts | GET | List all Contract | **TECHNICIAN_KEY***: API Key to access server. | https://<ip_address_8>:8080/sdplus/Contract/getAllContracts?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97 | | getAllPurchase | GET | List all Purchases | **TECHNICIAN_KEY***: API Key to access server. | https://<ip_address_8>:8080/sdplus/Purchase/getAllPurchase?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97 | | getAllProblems | GET | List all Problems | **TECHNICIAN_KEY***: API Key to access server. | https://<ip_address_8>: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. | https://<ip_address_8>: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. | https://<ip_address_8>:8080/sdplus/CMDB/getAssetRelationShips?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&ciID=603 | | getHardwareDetails | GET | Get details of CI Hardware | **TECHNICIAN_KEY***: API Key; **ciID***: Configuration Item ID. | https://<ip_address_8>:8080/sdplus/CMDB/getHardwareDetails?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&ciID=603 | | getSoftwareDetails | GET | Get details of asset - software | **TECHNICIAN_KEY***: API Key; **ciID***: Configuration Item ID. | https://<ip_address_8>: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; **ciID***: Configuration Item ID. | https://<ip_address_8>: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; **ciID***: Configuration Item ID. | https://<ip_address_8>:8080/sdplus/CMDB/getRPCDetails?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&ciID=603 | | getScanDetails | GET | Get details of asset - Scan | **TECHNICIAN_KEY***: API Key; **ciID***: Configuration Item ID. | https://<ip_address_8>: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; **ciID***: Configuration Item ID. | https://<ip_address_8>:8080/sdplus/CMDB/getContractsForAsset?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&ciID=603 | | getCostDetails | GET | Get cost details of asset | **TECHNICIAN_KEY***: API Key; **ciID***: Configuration Item ID. | https://<ip_address_8>:8080/sdplus/CMDB/getCostDetails?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&ciID=603 | | getProblemsInfo | GET | Get problem details | **TECHNICIAN_KEY***: API Key; **ProblemID***: Problem ID. | https://<ip_address_8>:8080/sdplus/Problem/getProblemsInfo?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&ProblemID=1 | | getProblemAnalysis | GET | Get problem analysis details | **TECHNICIAN_KEY***: API Key; **ProblemID***: Problem ID. | https://<ip_address_8>:8080/sdplus/Problem/getProblemAnalysis?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&ProblemID=1 | | getProblemSolution | GET | Get solution details for problem | **TECHNICIAN_KEY***: API Key; **ProblemID***: Problem ID. | https://<ip_address_8>: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; **ProblemID***: Problem ID. | https://<ip_address_8>: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; **ProblemID***: Problem ID. | https://<ip_address_8>:8080/sdplus/Problem/getProblemIncidents?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&ProblemID=1 | | getProblemHistory | GET | Get problem history | **TECHNICIAN_KEY***: API Key; **ProblemID***: Problem ID. | https://<ip_address_8>:8080/sdplus/Problem/getProblemHistory?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&ProblemID=1 | | getChangeInfo | GET | Get change details | **TECHNICIAN_KEY***: API Key; **ChangeID***: Change ID. | https://<ip_address_8>:8080/sdplus/Change/getChangeInfo?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&ChangeID=2 | | getContractDetails | GET | Get Contract details | **TECHNICIAN_KEY***: API Key; **contractID***: Contract ID. | https://<ip_address_8>: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; **contractID***: Contract ID. | https://<ip_address_8>: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; **contractID***: Contract ID. | https://<ip_address_8>:8080/sdplus/Contract/getContractRenewal?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&contractID=303 | | getChildContract | GET | Get child contract details | **TECHNICIAN_KEY***: API Key; **contractID***: Contract ID. | https://<ip_address_8>:8080/sdplus/Contract/getChildContract?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&contractID=303 | | getPoDetails | GET | Get purchase order details | **TECHNICIAN_KEY***: API Key; **PoID***: Purchase order ID. | https://<ip_address_8>: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; **PoID***: Purchase order ID. | https://<ip_address_8>:8080/sdplus/Purchase/getInvoiceAndPayment?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&PoID=1 | | getPoRequest | GET | Get Request associated with PO | **TECHNICIAN_KEY***: API Key; **PoID***: Purchase order ID. | https://<ip_address_8>: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 | **Usando la contraseña asociada:** **apiKey***: clave API; **deviceName***: nombre del dispositivo; **SelectedCredential***: `associatedPassword`. **Usando el nombre de la credencial:** **apiKey***, **deviceName***, **Credential***: nombre de credencial WMI; **SelectedCredential***: `credentialSelected`. | API: https://localhost:8060/api/json/admin/listActiveWindowsServices. Parámetros POST asociados: `apiKey:081c9ac51ba16ab061d5efee583dcd2f`, `deviceName:nfa-2k12r2-2.csez.zohocorpin.com`, `selectedCredential:associatedPassword`. Parámetros con credencial: `credential:WMIDevices`, `selectedCredential:credentialSelected`. | | **getWindowsServiceMonitor** | GET | Recibe información de Monitor de Servicio de Windows | **apiKey***: clave API; **serviceID***: identificación de servicio. Obtenga `serviceID` mediante consulta de BD: `seleccione id como "ServiceID", Nombre como "DisplayName", ServiceName de NTServicesDefinition donde Name='ReplaceDisplayNameHere' y ServiceName='ReplaceServiecNameHere'`. | https://localhost:8060/api/json/admin/getWindowsServiceMonitor?apiKey=081c9ac51ba16ab061d5efee583dcd2f&serviceID=301 | | **deleteWindowsServiceMonitor** | POST | Elimina Monitor de Servicio de Windows | **apiKey***: clave API; **serviceID***: identificación de servicio. | API: https://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***, **serviceID***, **failureThreshold*** y **actionType***. `actionType`: 0 sin acción, 1 reiniciar servicio, 2 reiniciar servidor. | API: https://localhost:8060/api/json/admin/updateWindowsServiceMonitor. Parámetros POST: `apiKey:081c9ac51ba16ab061d5efee583dcd2f`, `serviceID:2`, `failureThreshold:3`, `ActionType:1`. | | **addNTServiceMonitors** | POST | Agrega Servicios de Windows | **Agregar servicios:** **apiKey***, **name***, **discoverFromDevice**, **displayNames**, **serviceNames**. **Asignar servicios:** **apiKey***, **name***, **assignedNTServices**, **discoverFromDevice**: falso, **IsAdminPage**: verdadero. | API: https://localhost:8060/api/json/device/addNTServiceMonitors. Ejemplo: `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`. |