# API REST de OpManager
OpManager ofrece APIs REST para agregar y obtener datos desde OpManager. Usando estas APIs, puedes integrar OpManager con software de mesa de servicio/gestión de TI de terceros.
> **Nota:** Este documento proporciona una lista de APIs REST usadas para enviar datos de OpManager a fuentes externas.
>
> Para obtener más información sobre **ingresar datos desde sitios web externos** o herramientas de terceros en OpManager, [haz clic aquí](https://www.manageengine.com/network-monitoring/help/files/Ingest-data.pdf).
## ¿Cómo funcionan las APIs REST de OpManager?
Las APIs funcionan con una clave de API. La clave de API es única para cada cuenta de OpManager y es obligatoria para todas las solicitudes de API. [Aprende cómo habilitar o deshabilitar claves de API Rest](https://www.manageengine.com/latam/network-monitoring/help/rest-api-opmanager.html#enable).
## ¿Cómo ver una clave de API?
Para ver o copiar una clave de API, ve a Enlaces rápidos > opción Rest API Key en el cliente web de OpManager. La opción de enlace rápido es el ícono de engranaje en la esquina superior derecha.
## ¿Cómo enviar un apiKey?
La funcionalidad de autenticación de apiKey basada en parámetro de solicitud ha quedado obsoleta. Antes de la versión 128100, el apiKey se podía enviar mediante el parámetro de solicitud. A partir de la versión 128100, el apiKey ahora puede ser enviado ya sea en el encabezado de la solicitud o como un parámetro de solicitud.
> **Nota:** El soporte para la autenticación de apiKey basada en parámetro de solicitud terminará pronto. La siguiente lista de URL debe ser invocada con apiKey solo a través del encabezado de la solicitud. La autenticación ApiKey basada en parámetros de solicitud no funcionará para estas URL.
| API |
|---|
| **/api/json/alarm/listAlarms** |
| **/api/json/admin/addLinuxCredential** |
| **/api/json/discovery/addDiscoveryProfile** |
| **/api/json/discovery/editDiscoveryProfile** |
| **/api/json/v2/discovery/addDiscoveryProfile** |
| **/api/json/v2/discovery/editDiscoveryProfile** |
| **/api/json/ncmsettings/importSSHKey** |
| **/api/json/ncmsettings/importDevices** |
| **/api/json/ncmsettings/uploadConfigletFile** |
| **/api/json/ncmsettings/uploadConfigletPreView** |
| **/api/json/ncmsettings/importConfiglets** |
| **/api/json/ncmdevice/updateHostNamefromFileImp** |
| **/api/json/ncmdevice/editCustomColfromFileImp** |
| **/api/json/ncmdevice/importDG** |
| **/api/json/ipam/addSubnet** |
| **/api/json/spm/addSwitch** |
**Un ejemplo de configuración con header:**

## Habilitar / Deshabilitar acceso a Rest API
A partir de la versión 127131, se añadió la opción para habilitar/deshabilitar Rest API.
### ¿Qué ha cambiado?
- El acceso a Rest API estará deshabilitado por defecto para los nuevos usuarios creados bajo Gestión de usuarios. Un administrador con acceso completo a todos los módulos y dispositivos podrá editar al usuario en Gestión de usuarios y otorgar acceso a Rest API si es necesario.

- Si el acceso RestApikey ha sido habilitado para los usuarios, el menú Rest API bajo Enlaces rápidos mostrará el RestApikey, y las llamadas externas de Rest API solo serán permitidas si el acceso Rest API ha sido habilitado para el usuario.

- Si el acceso Rest API ha sido deshabilitado, el menú Rest API bajo Enlaces rápidos mostrará "Contact the administrator user".

> **Nota:**
>
> **Sincronización de usuarios en edición Enterprise:** El acceso a Rest API no se sincronizará para usuarios desde el servidor Central hacia los servidores Probe. Los usuarios sincronizados en los Probes no tendrán acceso permanente a Rest API. En cambio, para los usuarios creados en el servidor Probe, el acceso a Rest API se puede actualizar según sea necesario.
>
> **TFA:** Si se ha configurado Autenticación de dos factores, la validación del OTP de TFA es obligatoria para habilitar el acceso a Rest API.
>
> **Regenerar una clave de API:** Para generar una clave de API, ve a Settings > Basic Settings > REST API en el cliente web de OpManager y haz clic en Regenerate Key.
## Alarmas
### listAlarms
Esta API se usa para listar todas las alarmas generadas en OpManager.
#### Método HTTP
GET
#### URL de la API
```plaintext
http://localhost:8060/api/json/alarm/listAlarms?apiKey=********&deviceName=test1.zoho.com&severity=1&category=Device_Category&entity=sample_entity&alertType=ActiveAlarms&fromTime=2022-05-02 08:00:00&toTime=2022-06-02 18:30:00
```
#### Parámetros
| Nombre parámetro | Descripción | Tipo de dato | Información adicional | Es obligatorio |
|---|---|---|---|---|
| apiKey | Clave de API para acceder a tu servidor OpManager. | | | Sí |
| deviceName | Nombre del dispositivo para el cual se deben listar las alarmas. Esto se puede obtener usando la API listDevices. | String | Valores permitidos: cualquier nombre de dispositivo válido | No |
| severity | Severidad de la alarma. | | Valores permitidos: 1 (Crítica), 2 (Problema), 3 (Atención), 4 (Servicio caído), 5 (Despejada)
(ej., severity=1) | No |
| category | Categoría del dispositivo | | Un nombre de categoría válido.
Caracteres permitidos: Cualquier letra, número y estos símbolos: . , espacio ~ ` : \ / - _ | No |
| alertType | Tipo de alarmas. | | Valores permitidos: ActiveAlarms, EventLogAlarms, SyslogAlarms, TrapAlarms, NCMAlarms, NFAAlarms, WebAlarms, FWAAlarms, StorageAlarms, APMAlarms, Server, Network, Virtualization, CorrelatedAlarms.
(ej., alertType=ActiveAlarms) | No |
| fromTime | Hora de inicio para el rango de período de tiempo personalizado. | | Puede tener el formato yyyy-mm-dd o yyyy-mm-dd hh:mm:ss. Si no se especifica hora (es decir, formato yyyy-mm-dd), la hora por defecto será las 12 a. m. (inicio del día).
(ej., fromTime=2022-05-02 08:00:00) | No |
| toTime | Hora de fin para el rango de período de tiempo personalizado. | | Puede tener el formato yyyy-mm-dd o yyyy-mm-dd hh:mm:ss. Si no se especifica hora (es decir, formato yyyy-mm-dd), la hora por defecto será las 12 a. m. (inicio del día).
(ej., toTime=2022-06-02 18:30:00) | No |
| probeName | Nombre del Probe. El nombre del probe se puede obtener ejecutando la API listProbes, donde el parámetro name en la respuesta corresponde a probeName. [Aplicable solo para servidor central] | | Un nombre de probe válido.
Permitido: Cualquier combinación de letras, números, guiones bajos y espacios. | No |
#### Respuesta de ejemplo
Código HTTP: 200
```plaintext
{ "alarmPresent": true, "total": 1, "Details":{ "Server": [ { "label": "Attention", "value": 2, "status": 3} ]}, "pageLength": 100, "records": 2, "Acknowledge": "0", "Unacknowledge": "2", "severityVsCount":{ "Attention": 2}, "page": 1, "rowCount": 2, "rows": [ { "categoryString": "Server", "prettyTime": "147 days ago", "statusStr": "Attention", "isSuppressed": false, "displayName": "deviceName1", "lastNote": -1, "technician": "Unacknowledged", "message": "CPU Ready [VMware]'s data collection has been failing continuously", "deviceName": "deviceName1", "statusNum": 3, "suppressedMessage": "", "modTimeLong": 1748980058922, "modTime": "06/03/2025 12:47:38 PM PDT", "alarmId": 307, "eventtype": "Poll Failure", "category": "Server", "entity": "PollFailure_4260", "alarmcode": "PollFailure_Down_4260", "who": "Unacknowledge"}, { "categoryString": "Server", "prettyTime": "147 days ago", "statusStr": "Attention", "isSuppressed": false, "displayName": "deviceName2", "lastNote": -1, "technician": "Unacknowledged", "message": "CPU Utilization [VMware]'s data collection has been failing continuously", "deviceName": "deviceName2", "statusNum": 3, "suppressedMessage": "", "modTimeLong": 1748980058904, "modTime": "06/03/2025 12:47:38 PM PDT", "alarmId": 311, "eventtype": "Poll Failure", "category": "Server", "entity": "PollFailure_4266", "alarmcode": "PollFailure_Down_4266", "who": "Unacknowledge"} ], "notificationEnabled": true}
```
#### Respuesta de error
[Ver respuestas de error comunes](https://www.manageengine.com/network-monitoring/help/common-json-errors.html)
**Límite de velocidad:** 100 solicitudes por minuto. Superar este límite bloqueará las solicitudes durante 1 minuto.
### alarmProperties
Para listar las propiedades de alarma de una alarma en particular.
#### Método HTTP
GET
#### URL de la API
```plaintext
https://localhost:8060/api/json/alarm/alarmProperties?apiKey=***************&entity=sample_entity
```
#### Parámetros
| Nombre parámetro | Descripción | Tipo de dato | Información adicional | Es obligatorio |
|---|---|---|---|---|
| apiKey | Clave de API para acceder a tu servidor OpManager. | | | Sí |
| entity | Entidad de la alarma para la cual se deben obtener las propiedades de la alarma. Esto se puede obtener usando la API listAlarms. | | Nombre de entidad para la cual se deben obtener las propiedades.
Valores permitidos: Letras, números, espacios y estos símbolos: . ! & : @ # $ - _ ' , /
(ej., entity=sampleEntity1_Poll) | Sí |
#### Respuesta de ejemplo
Código HTTP: 200
```plaintext
{ "statusStr": "Critical", "stageStr": "New", "suppression": "false", "eventtype": "Threshold Down", "previousseverity": "3", "EVENTTYPE": "Threshold Down", "stage": "0", "modTime": "1666785470844", "createTime": "1666785470844", "pollid": "37", "category": "Desktop", "entity": "37_DiskUtilization", "stringpreviousseverity": "", "who": "Unacknowledge"}
```
#### Respuesta de error
[Ver respuestas de error comunes](https://www.manageengine.com/network-monitoring/help/common-json-errors.html)
**Límite de velocidad:** 50 solicitudes por minuto. Superar este límite bloqueará las solicitudes durante 1 minuto.
### addNotes
Esta API se usa para agregar notas a una alarma.
#### Método HTTP
POST
#### URL de la API
```plaintext
https://localhost:8060/api/json/alarm/addNotes?apiKey=***************&entity=sample_entity¬es=sample_notes
```
#### Parámetros
| Nombre parámetro | Descripción | Tipo de dato | Información adicional | Es obligatorio |
|---|---|---|---|---|
| apiKey | Clave de API para acceder a tu servidor OpManager. | | | Sí |
| entity | La entidad de la(s) alarma(s) a la(s) que se deben agregar las notas. Esto se puede obtener usando la API listAlarms. | | Lista separada por comas de nombres de entidad a los que se deben agregar las notas.
Valores permitidos: Letras, números, espacios y estos símbolos: . ! & : @ # $ - _ ' , /
(ej., entity=sampleEntity1_Poll) | Sí |
| notes | Descripción de las notas a agregar | | Valores permitidos: Letras, números, espacios y estos símbolos: . ! : @ # % $=> < & + * - \ / ' , _ ( ) ~ ` [ ]{} ^ ; \| ? " | Sí |
#### Respuesta de ejemplo
Código HTTP: 200
```plaintext
{ "result":{ "message": "Successfully Added"}}
```
#### Respuesta de error
[Ver respuestas de error comunes](https://www.manageengine.com/network-monitoring/help/common-json-errors.html)
**Límite de velocidad:** 50 solicitudes por minuto. Superar este límite bloqueará las solicitudes durante 1 minuto.
### acknowledgeAlarm
Esta API se usa para reconocer una alarma.
#### Método HTTP
POST
#### URL de la API
```plaintext
https://localhost:8060/api/json/alarm/acknowledgeAlarm?apiKey=***************&entity=sample_entity
```
#### Parámetros
| Nombre parámetro | Descripción | Tipo de dato | Información adicional | Es obligatorio |
|---|---|---|---|---|
| apiKey | Clave de API para acceder a tu servidor OpManager. | | | Sí |
| entity | Entidad de la(s) alarma(s) que se deben reconocer. Esto se puede obtener usando la API listAlarms. | | Lista separada por comas de nombres de entidad a reconocer.
Caracteres permitidos: Letras, números, espacios y estos símbolos: . ! & : @ # $ - _ ' , /
(ej., entity=sampleEntity1_Poll,sampleEntity2_Poll) | Sí |
#### Respuesta de ejemplo
Código HTTP: 200
```plaintext
{ "result":{ "message": "Alarm has been successfully Acknowledged"}}
```
#### Respuesta de error
[Ver respuestas de error comunes](https://www.manageengine.com/network-monitoring/help/common-json-errors.html)
**Límite de velocidad:** 50 solicitudes por minuto. Superar este límite bloqueará las solicitudes durante 1 minuto.
### unAcknowledgeAlarm
Esta API se usa para quitar el reconocimiento de una alarma.
#### Método HTTP
POST
#### URL de la API
```plaintext
http://localhost:8060/api/json/alarm/unAcknowledgeAlarm?apiKey=********&entity=sample_entity
```
#### Parámetros
| Nombre parámetro | Descripción | Tipo de dato | Información adicional | Es obligatorio |
|---|---|---|---|---|
| apiKey | Clave de API para acceder a tu servidor OpManager. | | | Sí |
| entity | Entidad de la(s) alarma(s) que se deben dejar sin reconocer. Esto se puede obtener usando la API listAlarms. | | Lista separada por comas de nombres de entidad a dejar sin reconocer.
Valores permitidos: Letras, números, espacios y estos símbolos: . ! & : @ # $ - _ ' , /
(ej., entity=sampleEntity1_Poll,sampleEntity2_Poll) | Sí |
#### Respuesta de ejemplo
Código HTTP: 200
```plaintext
{ "result":{ "message": "Alarm has been successfully UnAcknowledged"}}
```
#### Respuesta de error
[Ver respuestas de error comunes](https://www.manageengine.com/network-monitoring/help/common-json-errors.html)
**Límite de velocidad:** 50 solicitudes por minuto. Superar este límite bloqueará las solicitudes durante 1 minuto.
### clearAlarm
Esta API se usa para limpiar una alarma.
#### Método HTTP
POST
#### URL de la API
```plaintext
https://localhost:8060/api/json/alarm/clearAlarm?apiKey=***************&entity=sample_entity
```
#### Parámetros
| Nombre parámetro | Descripción | Tipo de dato | Información adicional | Es obligatorio |
|---|---|---|---|---|
| apiKey | Clave de API para acceder a tu servidor OpManager. | | | Sí |
| entity | Entidad de la(s) alarma(s) que se deben limpiar. Esto se puede obtener usando la API listAlarms. | | Lista separada por comas de nombres de entidad a limpiar.
Valores permitidos: Letras, números, espacios y estos símbolos: . ! & : @ # $ - _ ' , /
(ej., entity=sampleEntity1_Poll,sampleEntity2_Poll) | Sí |
#### Respuesta de ejemplo
Código HTTP: 200
```plaintext
{ "result":{ "message": "Alarm has been successfully Cleared!"}}
```
#### Respuesta de error
[Ver respuestas de error comunes](https://www.manageengine.com/network-monitoring/help/common-json-errors.html)
**Límite de velocidad:** 50 solicitudes por minuto. Superar este límite bloqueará las solicitudes durante 1 minuto.
### deleteAlarm
Esta API se usa para eliminar una alarma.
#### Método HTTP
POST
#### URL de la API
```plaintext
https://localhost:8060/api/json/alarm/deleteAlarm?apiKey=***************&entity=sample_entity
```
#### Parámetros
| Nombre parámetro | Descripción | Tipo de dato | Información adicional | Es obligatorio |
|---|---|---|---|---|
| apiKey | Clave de API para acceder a tu servidor OpManager. | | | Sí |
| entity | La entidad de la(s) alarma(s) que se deben borrar. Esto se puede obtener usando la API listAlarms. | | Lista separada por comas de nombres de entidad a eliminar.
Valores permitidos: Letras, números, espacios y estos símbolos: . ! & : @ # $ - _ ' , /
(ej., entity=sampleEntity1_Poll,sampleEntity2_Poll) | Sí |
#### Respuesta de ejemplo
Código HTTP: 200
```plaintext
{ "result":{ "message": "Alarm has been successfully Deleted!"}}
```
#### Respuesta de error
[Ver respuestas de error comunes](https://www.manageengine.com/network-monitoring/help/common-json-errors.html)
**Límite de velocidad:** 50 solicitudes por minuto. Superar este límite bloqueará las solicitudes durante 1 minuto.
### ConfigureSuppressAlarm
Esta API se usa para suprimir alarmas para un dispositivo específico.
#### Método HTTP
POST
#### URL de la API
```plaintext
https://localhost:8060/api/json/device/ConfigureSuppressAlarm?apiKey=&name=test.abc&suppressInterval=-2&startTime=2024-08-16 16:30&endTime=2024-08-16 16:50
```
#### Parámetros
| Nombre parámetro | Descripción | Tipo de dato | Información adicional | Es obligatorio |
|---|---|---|---|---|
| apiKey | Clave de API para acceder a tu servidor OpManager. | | | Sí |
| name | Nombre del dispositivo a suprimir. Esto se puede obtener usando la API listDevices. | String | Valores permitidos: cualquier nombre de dispositivo válido | Sí |
| suppressInterval | El período de tiempo durante el cual el dispositivo debe ser suprimido. | | Valores permitidos: 0 (nunca), -1 (para siempre), 3600000 (1 hora), 7200000 (2 horas), 28800000 (8 horas), 43200000 (12 horas), 86400000 (1 día), 604800000 (7 días), -2 (período de tiempo personalizado - para tiempo personalizado, especificar los parámetros startTime y endTime en el formato YYYY-MM-DD HH:MM)
(ej., suppressInterval=604800000) | Sí |
| startTime | Hora de inicio de la supresión de alarmas en formato YYYY-MM-DD HH:MM.
Debe especificarse solo para suppressInterval=-2 | | Formato permitido: YYYY-MM-DD HH:MM
Ejemplo: 2025-10-24 14:42 | No |
| endTime | Hora de fin de la supresión de alarmas en formato YYYY-MM-DD HH:MM.
Debe especificarse solo para suppressInterval=-2 | | Formato permitido: YYYY-MM-DD HH:MM
Ejemplo: 2025-10-24 14:42 | No |
#### Respuesta de ejemplo
Código HTTP: 200
```plaintext
{ "result":{ "message": "Alarm Suppression rule has been added successfully"}}
```
#### Respuesta de error
[Ver respuestas de error comunes](https://www.manageengine.com/network-monitoring/help/common-json-errors.html)
**Límite de velocidad:** 20 solicitudes por minuto. Superar este límite bloqueará las solicitudes durante 1 minuto.
### getAnnotation
Esta API se usa para obtener notas de las alarmas.
#### Método HTTP
GET
#### URL de la API
```plaintext
https://localhost:8060/api/json/alarm/getAnnotation?apiKey=***************&entity=sample_entity
```
#### Parámetros
| Nombre parámetro | Descripción | Tipo de dato | Información adicional | Es obligatorio |
|---|---|---|---|---|
| apiKey | Clave de API para acceder a tu servidor OpManager. | | | Sí |
| entity | La entidad de la alarma para la cual se deben obtener las notas. Esto se puede obtener usando la API listAlarms. | | Nombre de entidad para la cual se deben obtener las notas.
Valores permitidos: Letras, números, espacios y estos símbolos: . ! & : @ # $ - _ ' , / | Sí |
#### Respuesta de ejemplo
Código HTTP: 200
```plaintext
[ { "notes": "This is a test note", "modTime": 1666786020066, "noteID": 1, "modTimeStr": "26 Oct 2022 05:37:00 PM IST", "entity": "37_DiskUtilization", "who": "admin"}]
```
#### Respuesta de error
[Ver respuestas de error comunes](https://www.manageengine.com/network-monitoring/help/common-json-errors.html)
**Límite de velocidad:** 100 solicitudes por minuto. Superar este límite bloqueará las solicitudes durante 1 minuto.
### updateAlarmNote
Esta API se usa para actualizar notas de una alarma.
#### Método HTTP
POST
#### URL de la API
```plaintext
https://localhost:8060/api/json/alarm/updateAlarmNote?apiKey=***************¬eID=1¬es=sample_notes
```
#### Parámetros
| Nombre parámetro | Descripción | Tipo de dato | Información adicional | Es obligatorio |
|---|---|---|---|---|
| apiKey | Clave de API para acceder a tu servidor OpManager. | | | Sí |
| noteID | ID de la nota a actualizar. Esto se puede obtener usando la API getAnnotation. | long | Cualquier ID de nota válido | Sí |
| notes | Descripción de las notas a agregar | | Valores permitidos: Letras, números, espacios y estos símbolos: . ! : @ # % $=> < & + * - \ / ' , _ ( ) ~ ` [ ]{} ^ ; \| ? " | Sí |
#### Respuesta de ejemplo
Código HTTP: 200
```plaintext
{ "result":{ "message": "Note has been successfully updated"}}
```
#### Respuesta de error
[Ver respuestas de error comunes](https://www.manageengine.com/network-monitoring/help/common-json-errors.html)
**Límite de velocidad:** 50 solicitudes por minuto. Superar este límite bloqueará las solicitudes durante 1 minuto.
### GetSuppressAlarmDetails
Esta API se usa para obtener los detalles de supresión para un dispositivo específico.
#### Método HTTP
GET
#### URL de la API
```plaintext
https://localhost:8060/api/json/device/GetSuppressAlarmDetails?apiKey=***************&name=test.abc
```
#### Parámetros
| Nombre parámetro | Descripción | Tipo de dato | Información adicional | Es obligatorio |
|---|---|---|---|---|
| apiKey | Clave de API para acceder a tu servidor OpManager. | | | Sí |
| name | Nombre del dispositivo para el cual se obtendrán los detalles de supresión. El nombre del dispositivo se puede obtener usando la API listDevices. | String | Valores permitidos: cualquier nombre de dispositivo válido | Sí |
#### Respuesta de ejemplo
Código HTTP: 200
```plaintext
{ { "List": [ { "configID": 10000000602, "LASTUPDATEDTIME": 1761320552761, "startTime": "24 Oct 2025 09:12:32 PM IST", "endTime": "25 Oct 2025 05:12:32 AM IST", "userName": "admin", "message": "Alarms are suppressed till : 25 Oct 2025 05:12:32 AM IST", "suppressInterval": "28800000"} ]}
```
#### Respuesta de error
[Ver respuestas de error comunes](https://www.manageengine.com/network-monitoring/help/common-json-errors.html)
**Límite de velocidad:** 20 solicitudes por minuto. Superar este límite bloqueará las solicitudes durante 1 minuto.
## Disponibilidad
### getPingResponse
Respuesta ICMP/Ping para el dispositivo dado.
#### Método HTTP
POST
#### URL de la API
```plaintext
https://localhost:8060/api/json/device/getPingResponse?apiKey=***************&deviceName=xxx.xxx.xx.x
```
#### Parámetros
| Nombre parámetro | Descripción | Tipo de dato | Información adicional | Es obligatorio |
|---|---|---|---|---|
| apiKey | Clave de API para acceder a tu servidor OpManager. | String | - | Sí |
| deviceName | Nombre del dispositivo: nombre de entidad administrada tal como se ve en la URL de la página de instantánea del dispositivo O el valor de la propiedad 'deviceName' en la respuesta de la API listDevices. | String | - | Sí |
| fromAddDevice | ¿Respuesta de Ping desde la página Add Device/Server? | Boolean | - | No |
| isBulk | Para respuesta de ping masiva en la página Inventory | Boolean | - | No |
| fromWANLink | ¿Respuesta de Ping desde la página Add WAN Link? | Boolean | - | No |
#### Respuesta de ejemplo
Código HTTP: 200
```plaintext
{ "PingResponse":{ "Details": "Pinging 127.0.0.1 with 32 bytes of data: Reply from 127.0.0.1: bytes=32 time=21ms TTL=251 Ping statistics for 127.0.0.1: Packets: Sent=1, Received=1, Lost=0 (0% loss), Approximate round trip times in milli-seconds: Minimum=21ms, Maximum=21ms, Average=21ms"}}
```
#### Respuesta de error
[Ver respuestas de error comunes](https://www.manageengine.com/network-monitoring/help/common-json-errors.html)
**Límite de velocidad:** 500 solicitudes por minuto. Superar este límite bloqueará las solicitudes durante 1 minuto.
### getTraceResponse
Respuesta del comando traceroute para el dispositivo dado.
#### Método HTTP
POST
#### URL de la API
```plaintext
https://localhost:8060/api/json/device/getTraceResponse?apiKey=***************&deviceName=xxx.xxx.xx.x
```
#### Parámetros
| Nombre parámetro | Descripción | Tipo de dato | Información adicional | Es obligatorio |
|---|---|---|---|---|
| apiKey | Clave de API para acceder a tu servidor OpManager. | String | - | Sí |
| deviceName | Nombre del dispositivo: nombre de entidad administrada tal como se ve en la URL de la página de instantánea del dispositivo O el valor de la propiedad 'deviceName' en la respuesta de la API listDevices. | String | - | Sí |
| fromWANLink | ¿Respuesta de Trace desde la página Add WAN Link? | String | - | No |
#### Respuesta de ejemplo
Código HTTP: 200
```plaintext
{ "TraceResponse":{ "Details": "Tracing route to 127.0.0.1 over a maximum of 30 hops 1 8 ms 9 ms 3 ms 127.0.0.1 2 1 ms 1 ms 1 ms 127.0.0.1 3 20 ms 20 ms 20 ms 127.0.0.1 4 22 ms 21 ms 22 ms 127.0.0.1 5 21 ms 20 ms 20 ms 127.0.0.1 Trace complete."}}
```
#### Respuesta de error
[Ver respuestas de error comunes](https://www.manageengine.com/network-monitoring/help/common-json-errors.html)
**Límite de velocidad:** 500 solicitudes por minuto. Superar este límite bloqueará las solicitudes durante 1 minuto.
### getDownDevices
Lista los dispositivos que están actualmente en estado caído y con estado de dispositivo "crítico".
#### Método HTTP
GET
#### URL de la API
```plaintext
https://localhost:8060/api/json/discovery/getDownDevices?apiKey=******************
```
#### Parámetros
| Nombre parámetro | Descripción | Tipo de dato | Información adicional | Es obligatorio |
|---|---|---|---|---|
| apiKey | Clave de API para acceder a tu servidor OpManager. | String | - | Sí |
#### Respuesta de ejemplo
Código HTTP: 200
```plaintext
{ "DownDevices":{ "Details": [ { "name": "127.0.0.1", "type": "HPSwitch 3900X", "category": "Switch", "displayName": "SwitchDevice_SP"}, { "name": "127.0.0.2", "type": "Windows Server 2018", "category": "Server", "displayName": "AppServer-04"}, { "name": "UserPC_Michael", "type": "Linux RedHat", "category": "Server", "displayName": "127.0.0.3"} ]}}
```
#### Respuesta de error
[Ver respuestas de error comunes](https://www.manageengine.com/network-monitoring/help/common-json-errors.html)
**Límite de velocidad:** 100 solicitudes por minuto. Superar este límite bloqueará las solicitudes durante 5 minutos.
### getAvailabilityGraphData
Obtiene las gráficas de disponibilidad para el dispositivo o interfaz dado.
#### Método HTTP
GET
#### URL de la API
```plaintext
https://localhost:8060/api/json/device/getAvailabilityGraphData?apiKey=******************&isFluidic=true&name=opmserver.mydomain.com
```
#### Parámetros
| Nombre parámetro | Descripción | Tipo de dato | Información adicional | Es obligatorio |
|---|---|---|---|---|
| apiKey | Clave de API para acceder a tu servidor OpManager. | String | - | Sí |
| name | Nombre del dispositivo o interfaz: nombre de entidad administrada tal como se ve en la URL de la página de instantánea del dispositivo/interfaz O el valor de la propiedad 'deviceName' de la API listDevices o el valor de la propiedad 'interfaceName' en la respuesta de la API listInterfaces [Ejemplo: opmserver.mydomain.com o IF-xx.xx.24.223-115] | String | - | Sí |
| isFluidic | Establecer valor como TRUE por defecto (para uso interno) | Boolean | - | Sí |
| instance | Establece instance=Interface si se solicita la gráfica de Disponibilidad para la interfaz. Campo obligatorio si se obtienen datos de interfaz. Esta API también se puede usar para obtener disponibilidad de otros monitores. [Ejemplo: Interface\|URL\|winService\|service\|process] | String | Valores permitidos: Interface, URL, winService, service, process, MerakiUplink, WANLinkMonitor | No |
| elementID | Este es el ID único obtenido de la columna de la tabla managedobject | Long | - | No |
#### Respuesta de ejemplo
Código HTTP: 200
```plaintext
{ "uptimeData":{ "Today": 100, "Yesterday": 100, "This Week": 100, "Last Week": 100, "This Month": 99.98, "Last Month": 100, "This Quarter": 99.98, "Last Quarter": 100, "This Year": 99.98, "Last Year": 0}, "availabilityData": [ { "name": "Last 24 Hours", "points": [ { "y": 100, "x": 1661392800000, "toolTipKey": "Aug 25, 12:00 AM", "color": "#1A8F47"} ]} ]}
```
#### Respuesta de error
[Ver respuestas de error comunes](https://www.manageengine.com/network-monitoring/help/common-json-errors.html)
**Límite de velocidad:** 100 solicitudes por minuto. Superar este límite bloqueará las solicitudes durante 1 minuto.
### listDownTimeSchedules
Proporciona la lista de programaciones de inactividad creadas en OpManager.
#### Método HTTP
GET
#### URL de la API
```plaintext
https://localhost:8060/api/json/admin/listDownTimeSchedules?apiKey=****************&callAction=settings
```
#### Parámetros
| Nombre parámetro | Descripción | Tipo de dato | Información adicional | Es obligatorio |
|---|---|---|---|---|
| apiKey | Clave de API para acceder a tu servidor OpManager. | String | - | Sí |
| callAction | Página desde donde se realiza esta acción | String | - | Sí |
#### Respuesta de ejemplo
Código HTTP: 200
```plaintext
[ { "MODIFIED_BY": "admin", "MODIFIED_TIME_STR": "at Oct 7, 2025 11:42", "type": "Once", "nextscheduledtime": "Tue, Oct 7, 2025 12:00:00", "statusNum": "1", "ADDED_TIME": "1759817559532", "MODIFIED_TIME": "1759817559532", "suppressType": "Monitoring", "name": "DemoSchedule", "id": "1", "ADDED_BY": "admin", "ADDED_TIME_STR": "at Oct 7, 2025 11:42", "status": "Enabled"}]
```
#### Respuesta de error
[Ver respuestas de error comunes](https://www.manageengine.com/network-monitoring/help/common-json-errors.html)
**Límite de velocidad:** 100 solicitudes por minuto. Superar este límite bloqueará las solicitudes durante 1 minuto.
### addDowntimeSchedule
Te permite programar períodos de inactividad para grupos y dispositivos.
#### Método HTTP
POST
#### URL de la API
```plaintext
https://localhost:8060/api/json/admin/addDowntimeSchedule?apiKey=&operation=Add&scheduleName=FirmwareUpgrade&status=Enabled&scheduleDesc=&recurrence=OnceOnly&selectDevicesMethod=Device&once_startat=2024-07-10 00:00&once_endat=2024-07-11 04:00&selectedDevices=10.5.5.1,30.30.30.6,opm-sql
```
#### Parámetros
| Nombre parámetro | Descripción | Tipo de dato | Información adicional | Es obligatorio |
|---|---|---|---|---|
| apiKey | Clave de API para acceder a tu servidor OpManager. | String | - | Sí |
| operation | Add (para crear una nueva programación de inactividad) | String | Valores permitidos: Add, Edit | Sí |
| scheduleName | Nombre de la programación (valor String) | String | Caracteres permitidos: A-Z, a-z, 0-9, espacio( ), guion bajo(_) | Sí |
| status | Habilitado/Deshabilitado | String | Valores permitidos: Enabled, Disabled | Sí |
| scheduleDesc | Descripción del programador de inactividad (Opcional) | String | Caracteres permitidos: A-Z, a-z, 0-9, espacio( ), guion bajo(_), punto(.), barra(/), barra vertical(\|), signo de interrogación(?), guion(-), tilde(~) | No |
| recurrence | OnceOnly/Daily | String | Valores permitidos: OnceOnly, Daily, Weekly, Monthly | Sí |
| selectDevicesMethod | Device | String | Valores permitidos: Category, BV, Device, URL, GROUP | Sí |
| selectedCateg | Categoría de dispositivo (aplicable solo si selectDevicesMethod es 'Category') | String | Caracteres permitidos: A-Z, a-z, 0-9, espacio( ), guion bajo(_), punto(.), barra(/), barra vertical(\|), signo de interrogación(?), guion(-), tilde(~) | No |
| selectedBV | Nombre de la vista de negocio con sufijo '_bv' (aplicable solo si selectDevicesMethod es 'Business View') | String | - | No |
| selectedDevices | IP del dispositivo (valores separados por comas) | String | - | No |
| selectedURL | Nombre del monitor de URL (aplicable solo si selectDevicesMethod es 'URLs') | String | - | No |
| selectedLogicalGroups | Nombre de grupos de dispositivos (valores separados por comas) | String | Caracteres permitidos: A-Z, a-z, todas las letras Unicode, 0-9, espacio( ), guion bajo(_), guion(-), punto(.), signo de exclamación(!), dos puntos(:), arroba(@), numeral(#), dólar($), barra invertida(\), barra(/), comilla simple('), coma(,) | No |
| once_startat | Fecha y hora de inicio (aplicable solo si recurrence es 'OnceOnly') | String | Caracteres permitidos: Dígitos(0-9), guion(-), espacio( ), dos puntos(:) | No |
| once_endat | Fecha y hora de fin (aplicable solo si recurrence es 'OnceOnly') | String | Caracteres permitidos: Dígitos(0-9), guion(-), espacio( ), dos puntos(:) | No |
| startday | Día de inicio de la semana (aplicable solo para Daily) | String/Int | Valores permitidos: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, 1-31, 32 | No |
| endday | Día de fin de la semana (aplicable solo para Daily) | String/Int | Valores permitidos: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, 1-31, 32 | No |
| from_time | Fecha y hora de inicio (aplicable solo si recurrence es 'Daily') | String | Valores permitidos: 00:00-23:59 (horas 00-23, minutos 00-59) | No |
| to_time | Fecha y hora de fin (aplicable solo si recurrence es 'Daily') | String | Valores permitidos: 00:00-23:59 (horas 00-23, minutos 00-59) | No |
| daily_effectfrom | Fecha y hora de inicio del programador de inactividad (aplicable solo si recurrence es 'Daily') | String | Valores permitidos: año-mes-día (0000-9999 para año, 01-12 para mes, 01-31 para día) | No |
| from_hrs | Hora de inicio (aplicable solo si recurrence es 'Monthly') | Int | Valores permitidos: 00-23 | No |
| to_hrs | Hora de fin (aplicable solo si recurrence es 'Monthly') | Int | Valores permitidos: 00-23 | No |
| from_mins | Minutos de inicio (aplicable solo si recurrence es 'Monthly') | Int | Valores permitidos: 00-59 | No |
| to_mins | Minutos de fin (aplicable solo si recurrence es 'Monthly') | Int | Valores permitidos: 00-59 | No |
| monthlyType | monthlyDate \| monthlyDay (aplicable solo si recurrence es 'Monthly') | String | Valores permitidos: monthlyDate, monthlyDay | No |
| weekOfMonth | Semana del mes | String | Valores permitidos: First, Second, Third, Fourth, Last | No |
| weekday | Día de la semana (aplicable solo si recurrence es 'Monthly' y monthlyType es 'monthlyDay') | String/Int | Valores permitidos: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, 1-31, 32 | No |
| mailID | Correo electrónico al cual se debe enviar el reporte | String | Caracteres permitidos: A-Z, a-z, 0-9, guion bajo(_), guion(-), punto(.), signo más(+), comilla simple('), barra(/), arroba(@), coma(,), espacio( ) | No |
| suppressType | Para suprimir Alarm o Monitoring | String | Valores permitidos: Alarm, Monitoring | No |
| timeZone | Zona horaria | String | Caracteres permitidos: A-Z, a-z, 0-9, guion bajo(_), guion(-), barra(/) | No |
| stopDTS | Detener programación de inactividad. Por defecto es false | Boolean | - | No |
| selectedValue | Valores seleccionados | String | Caracteres permitidos: A—Z, a—z, 0—9, guion bajo(_), guion(-), punto(.), signo más(+), comilla simple('), barra(/), arroba(@), coma(,), espacio( ) | No |
#### Respuesta de ejemplo
Código HTTP: 200
```plaintext
{ "result":{ "message": "Downtime Scheduler has been added successfully.", "scheduleID": 7}}
```
#### Respuesta de error
[Ver respuestas de error comunes](https://www.manageengine.com/network-monitoring/help/common-json-errors.html)
**Límite de velocidad:** 50 solicitudes por minuto. Superar este límite bloqueará las solicitudes durante 1 minuto.
... (traducción continúa con el mismo patrón para el resto del contenido HTML)