URL de solicitud

OBTENER

https://api.dotcom-monitor.com/config_api_v1/dispositivo {device_id} /

Obtenga la configuración del dispositivo por su id.

Parámetros de ruta

Campo Tipo Obligatorio Descripción
device_id

Cadena

true

 Identificador único de un dispositivo de supervisión. Para solicitar una lista de los ID de los dispositivos dentro de una plataforma, consulte API: Obtener lista de dispositivos por plataforma.

Para ver un identificador de dispositivo desde tu cuenta de monitor puntocom, abre el dispositivo de destino en la lista Administrador de dispositivos para editarlo. En la barra de direcciones del navegador verás algo como:

https://user.dotcom-monitor.com/ClientID/DeviceEdit?pid=dc7f4ff2ca944dekjh1078b96707002&deviceId=63698&taskId=132834

El deviceId=63698 es el IDENTIFICADOR del dispositivo.

Respuesta de éxito

Ejemplo serverView/BrowserView Device JSON Object 
{
    "Avoid_Simultaneous_Checks": false,
    "Alert_Silence_Min": 94,
    "False_Positive_Check": false,
    "Locations": [
        1,
        4,
        6,
        14,
        15,
        17,
        19,
        23,
        43,
        71,
        73
    ],
    "Tags": null,
    "ContextParams": [],
    "Send_Uptime_Alert": false,
    "Status_Description": "POSTPONED",
    "Postpone": true,
    "Owner_Device_Id": 0,
    "Frequency": 10800,
    "Filter_Id": 7791,
    "Scheduler_Id": 0,
    "Notifications": {
        "E_Mail_Flag": false,
        "E_Mail_Address": null,
        "E_Mail_TimeInterval_Min": 0,
        "WL_Device_Flag": false,
        "WL_Device_Email_Address": null,
        "WL_Device_TimeInterval_Min": 0,
        "Pager_Flag": false,
        "Pager_Area_Code": null,
        "Pager_Phone": null,
        "Pager_Num_Code": null,
        "Pager_TimeInterval_Min": 0,
        "Phone_Flag": false,
        "Phone_Area_Code": null,
        "Phone_Phone": null,
        "Phone_TimeInterval_Min": 0,
        "SMS_Flag": false,
        "SMS_Phone": null,
        "SMS_TimeInterval_Min": 0,
        "Script_Flag": false,
        "Script_Batch_File_Name": null,
        "Script_TimeInterval_Min": 0,
        "SNMP_TimeInterval_Min": 0,
        "Teams_TimeInterval_Min": 0,
        "Slack_TimeInterval_Min": 0,
        "AlertOps_TimeInterval_Min": 0,
        "PagerDuty_TimeInterval_Min": 0,
        "Notification_Groups": []
    },
    "Id": 47432,
    "Number_Of_Tasks": 1,
    "WaitingForApproval": false,
    "Platform_Id": 1,
    "Package_Id": 52,
    "Name": "FullPageDomain.cs"
}

Descripción de los campos

Utilice estos campos para especificar información sobre un dispositivo en sus solicitudes de API.

Campo

Tipo

 Descripción

Avoid_Simultaneous_Checks

booleano

 Indica si se permite la comprobación simultánea desde varias ubicaciones de supervisión. Disponible solo para dispositivos ServerView.

Ejemplo:
"Avoid_Simultaneous_Checks": true

Alert_Silence_Min

int32

 SOLO LECTURA. Define el período de tiempo en minutos cuando todas las alertas están deshabilitadas. Para deshabilitar las alertas, use API: Deshabilitar alertas para dispositivos o API: Deshabilitar alertas para varios dispositivos.

Ejemplo:
"Alert_Silence_Min": 46

False_Positive_Check

booleano

 Cuando se detecta el error, ejecutamos series de comprobaciones para asegurarnos de que no es una alerta falsa. Esas comprobaciones pueden tardar algún tiempo, dependiendo del tipo de error y el número de tareas en el dispositivo. Esto puede causar algún retraso en la alerta de tiempo de inactividad. Puede deshabilitar la comprobación de falsopositivo (“verdadero” del estado) para garantizar una alerta de tiempo de inactividad inmediata, pero puede dar lugar a algunas alertas “falsas”. Recomendamos NO desactivar “Verificación de falsos positivos”.

Ejemplo:
"False_Positive_Check": false

Localizaciones

matriz de int32

 Matriz que contiene identificadores de ubicación asignados a un dispositivo especificado. Se debe especificar al menos una ubicación en las solicitudes.

Ejemplo:
"Locations": [1, 2, 4, 5, 8]

Etiquetas

matriz de cadena

 Matriz que contiene los nombres de las etiquetas asignadas a un dispositivo especificado.

Ejemplo:
"Tags": ["green", "red", "black"]

Send_Uptime_Alert

booleano

 Cuando esta opción está habilitada, recibirá una alerta cuando se resuelvan todos los errores detectados.

Ejemplo:
"Send_Uptime_Alert": false

Status_Description

Cadena

 SOLO LECTURA. Describir el estado actual del dispositivo.

Ejemplo:
"Status_Description": "POSTPONED"

Posponer

booleano

 La supervisión se puede configurar en una pausa posponiendo un dispositivo.

Ejemplo:
"Postpone": true,

Owner_Device_Id

int32

 Este campo refleja el ID de dispositivo del propietario.

Ejemplo:
"Owner_Device_Id": 8534

Frecuencia

int32

 Este campo refleja la frecuencia de monitoreo en segundos.

Ejemplo:
"Frequency": 10800

Filter_Id

int32

 Este campo refleja el ID de filtro asignado a un dispositivo.

Ejemplo:
"Filter_Id": 853

Scheduler_Id

int32

 Este campo refleja el ID del programador asignado a un dispositivo.

Ejemplo:
"Scheduler_Id": 534

Notificaciones

matriz de objetos

 Indica la lista de ajustes de alertas

Ejemplo #1:
"Notifications":
{
"E_Mail_Flag": true,
"E_Mail_Address": "demo@at.com",
"E_Mail_TimeInterval_Min": 10
}
Ejemplo #2:
"Notifications":
{
"Notification_Groups":
[{
"Id": 608,
"Time_Shift_Min": 10
}]
}

E_Mail_Flag

booleano

 Define si se enviará la alerta de correo electrónico.

Ejemplo:
"E_Mail_Flag": false

E_Mail_Address

Cadena

 Especifica una dirección de correo electrónico para las alertas por correo electrónico.

Ejemplo:
"E_Mail_Address": "demo@company.com"

E_Mail_TimeInterval_Min

int32

 Este campo permite establecer un intervalo entre las alertas de correo electrónico en minutos

Ejemplo:
"E_Mail_TimeInterval_Min": 15

WL_Device_Flag

booleano

 Define si se enviará la alerta del dispositivo inalámbrico.

Ejemplo:
"WL_Device_Flag": false

WL_Device_Email_Address

Cadena

 Este campo especifica un dispositivo inalámbrico, como el teléfono o el buscapersonas, para las alertas.

Ejemplo:
"WL_Device_Email_Address": "wireless@company.com"

WL_Device_TimeInterval_Min

int32

 Este campo permite establecer un intervalo entre las alertas de dispositivos inalámbricos en minutos.

Ejemplo:
"WL_Device_TimeInterval_Min": 13

Pager_Flag

booleano

 Define si se enviarán alertas de buscapersonas.

Ejemplo:
"Pager_Flag": true

Pager_Area_Code

Cadena

 Código de área del buscapersona.

Ejemplo:
"Pager_Area_Code": "917"

Pager_Phone

Cadena

 Teléfono buscapersona.

Ejemplo:
"Pager_Phone": "3214564"

Pager_Num_Code

Cadena

 Código para un buscapersonas numérico.

Ejemplo:
"Pager_Num_Code": "225"

Pager_TimeInterval_Min

int32

 Este campo permite establecer un intervalo entre las alertas del localizador en minutos.

Ejemplo:
"Pager_TimeInterval_Min": 5

Phone_Flag

booleano

 Define si se llevarán a cabo alertas de llamadas telefónicas. Para recibir alertas a través del valor establecido por el teléfono en “true” y especifique el número de teléfono. Las alertas telefónicas son interactivas, lo que le permite posponer las alertas posteriores una vez recibida una alerta.

Ejemplo:
"Phone_Flag": true

Phone_Area_Code

Cadena

 Si el código de país es “1” (por ejemplo, en EE. UU., Canadá y Caribe), escriba el código de área y el número (por ejemplo, 952-5134349). Para todos los demás códigos de país, utilice el prefijo “011”, el código de país y el número de teléfono (por ejemplo, 011-44-95-2244392).

Ejemplo:
"Phone_Area_Cde": "952"

Phone_Phone

Cadena

 Número de teléfono.

Ejemplo:
"Phone_Phone": "5134349"

Phone_TimeInterval_Min

int32

 Este campo permite establecer un intervalo entre llamadas telefónicas.

Ejemplo:
"Phone_TimeInterval_Min": 2

SMS_Flag

booleano

 Define si se enviarán alertas SMS.

Ejemplo:
"SMS_Flag": false

SMS_Phone

 Cadena Un número de teléfono con un código de país (por ejemplo: US – 1 952 513 4349; Reino Unido 449524 4392). NO utilice un prefijo de marcación internacional, como “011” en el número.

Ejemplo:
"SMS_Phone": "19525134349"

SMS_TimeInterval_Min

int32

 Este campo permite establecer un intervalo entre alertas POR SMS.

Ejemplo:
"SMS_TimeInterval_Min": 0

Script_Flag

booleano

 Este campo define si las alertas se realizarán mediante scripts de alerta personalizados.

Ejemplo:
"Script_Flag": false

Script_Batch_File_Name

Cadena

 Nombre de archivo de script personalizado. Script Tiene que estar ya instalado en el servidor.

Ejemplo:
"Script_Batch_File_Name":"alerting.cs"

Script_TimeInterval_Min

int32

 Este campo permite establecer un intervalo entre alertas de script personalizadas.

Ejemplo:
"Script_TimeInterval_Min":5

Notification_Groups

matriz de objetos

 Indica los grupos de alertas activos con su ID y su turno de tiempo. El cambio de hora es una opción que le permite crear un proceso de escalamiento de alertas que se basa en la duración de la condición de error, por ejemplo, el primer grupo de notificaciones podría ser notificado inmediatamente, segundo después de 10 minutos de tiempo de inactividad y tercer grupo después de 60 minutos de tiempo de inactividad. Los intervalos de tiempo de escalación de alertas varían de inmediato a tres horas.

Ejemplo:
"Notification_Groups":
[{
"Id": 608,
"Time_Shift_Min": 10
}, {
"Id": 609,
"Time_Shift_Min": 20
}]

Number_Of_Tasks

int32

 LEER SOLAMENTE Campo. Muestra el número de tareas en el dispositivo especificado.

Ejemplo:
"Number_Of_Tasks": 15

Id

int32

 LEER SOLAMENTE Campo. El identificador de dispositivo único. Asignado automáticamente tras la creación de un nuevo dispositivo. Se usa para especificar un dispositivo en las solicitudes.

Ejemplo:
"Id": 8533

Platform_Id

int32

 LEER SOLAMENTE Campo. Cada plataforma (ServerView, UserView, etc.) tiene su propio ID. Vea cómo obtener los IDs de las plataformas aquí.

Ejemplo:
"Platform_Id": 1

Nombre

Cadena

 Nombre del dispositivo.

Ejemplo:
"Name": "new name"