Referencia de la API de integración para consolas de administración locales (versión preliminar pública)
En este artículo se enumeran las API admitidas para integrar Microsoft Defender para IoT con los servicios de asociados.
Por ejemplo, esta API se implementa actualmente con Tutorial: Integración de ServiceNow con Microsoft Defender para IoT, mediante ServiceNow Service Graph Connector para Defender para IoT.
Nota
Las API de integración están diseñadas para ejecutarse continuamente y crear un flujo de datos en ejecución constante, como para consultar nuevos datos de los últimos cinco minutos. Las API de integración devuelven datos con una marca de tiempo.
Para consultar simplemente los datos, use las API normales que no son de integración en su lugar, para que una consola de administración local consulte todos los dispositivos o un sensor específico solo para consultar dispositivos desde ese sensor. Para obtener más información, consulte referencia de la API de Defender para IoT.
URI: /external/v3/integration/
dispositivos (crear y actualizar dispositivos)
Esta API devuelve datos sobre todos los dispositivos que se actualizaron después de la marca de tiempo especificada.
URI: /external/v3/integration/devices/<timestamp>
parámetros de URI:
Nombre | Descripción | Ejemplo | Obligatorio/Opcional |
---|---|---|---|
marca de tiempo | Hora de inicio a partir de la cual se devuelven los resultados, en milisegundos desde hora de época y en zona horaria UTC. | /external/v3/integration/devices/1664781014000 |
Obligatorio |
OBTENER
-
de solicitud de
-
de respuesta de
- comando cURL
Parámetros de consulta:
Nombre | Descripción | Ejemplo | Obligatorio/Opcional |
---|---|---|---|
sensorId | Devuelve solo los dispositivos vistos por un sensor específico. Use el valor de identificador de los resultados de los sensores de (Obtener sensores) API. | 1 |
Opcional |
notificationType | Determina los tipos de dispositivos que se van a devolver. Entre los valores admitidos se incluyen: - 0 : dispositivos actualizados y nuevos (valor predeterminado). - 1 : solo dispositivos nuevos. - 2 : solo dispositivos actualizados. |
2 |
Opcional |
de página de |
Define el número donde comienza la numeración de la página de resultados. Por ejemplo, 0 = primera página es 0. Valor predeterminado = 0 |
0 |
Opcional |
de tamaño | Define el ajuste de tamaño de la página. Valor predeterminado = 50 |
75 |
Opcional |
conexiones (Obtener conexiones de dispositivo)
Esta API devuelve datos sobre todas las conexiones de dispositivo que se actualizaron después de la marca de tiempo especificada.
URI: /external/v3/integration/connections/<timestamp>
parámetros de URI:
Nombre | Descripción | Ejemplo | Obligatorio/Opcional |
---|---|---|---|
marca de tiempo | Hora de inicio a partir de la cual se devuelven los resultados, en milisegundos desde hora de época y en zona horaria UTC. | /external/v3/integration/devices/1664781014000 |
Obligatorio |
OBTENER
-
de solicitud de
-
de respuesta de
- comando cURL
Parámetros de consulta:
Nombre | Descripción | Ejemplo | Obligatorio/Opcional |
---|---|---|---|
de página de |
Define el número donde comienza la numeración de la página de resultados. Por ejemplo, 0 = primera página es 0. Valor predeterminado = 0 |
0 |
Opcional |
de tamaño | Define el ajuste de tamaño de la página. Valor predeterminado = 50 |
75 |
Opcional |
device (Obtener detalles de un dispositivo)
Esta API devuelve datos sobre un dispositivo específico por un identificador de dispositivo determinado.
URI: /external/v3/integration/device/{deviceId}
OBTENER
-
de solicitud de
-
de respuesta de
- comando cURL
Parámetros de consulta:
Nombre | Descripción | Ejemplo | Obligatorio/Opcional |
---|---|---|---|
deviceId | El identificador del dispositivo solicitado en la consola de administración local | 1 |
Obligatorio |
deleteddevices (Obtener dispositivos eliminados)
Esta API devuelve una lista de identificadores de dispositivos eliminados recientemente, de la marca de tiempo proporcionada.
URI: /external/v3/integration/deleteddevices/
OBTENER
-
de solicitud de
-
de respuesta de
- comando cURL
parámetros de URI:
Nombre | Descripción | Ejemplo | Obligatorio/Opcional |
---|---|---|---|
marca de tiempo | Hora de inicio a partir de la cual se devuelven los resultados, en milisegundos desde hora de época y en zona horaria UTC. | /external/v3/integration/deleteddevices/1664781014000 |
Obligatorio |
sensores (Obtener sensores)
Esta API devuelve una lista de objetos de sensor para los sensores de red de OT conectados.
URI: /external/v3/integration/sensors/
OBTENER
-
de solicitud de
-
de respuesta de
- comando cURL
URI: /sensors
Sin parámetros de consulta
devicecves (Obtener CV de dispositivo)
Esta API devuelve una lista de cves activos para todos los dispositivos que se actualizaron desde la marca de tiempo proporcionada.
URI: /external/v3/integration/devicecves/
OBTENER
-
de solicitud de
-
de respuesta de
- comando cURL
URI: /external/v3/integration/devicecves/<timestamp>
Parámetros de URI
Nombre | Descripción | Ejemplo | Obligatorio/Opcional |
---|---|---|---|
marca de tiempo | Hora de inicio a partir de la cual se devuelven los resultados, en milisegundos desde hora de época y en zona horaria UTC. | /external/v3/integration/devicecves/1664781014000 |
Obligatorio |
Parámetros de consulta
Nombre | Descripción | Ejemplo | Obligatorio/Opcional |
---|---|---|---|
de página de |
Define el número donde comienza la numeración de la página de resultados. |
0 = la primera página es 0. Valor predeterminado = 0 |
Opcional |
de tamaño | Define el ajuste de tamaño de la página. | Valor predeterminado = 50 |
Opcional |
sensorId | Muestra los resultados de un sensor específico, tal como se define en el identificador de sensor especificado. | 1 |
Opcional |
puntuación | Determina una puntuación mínima de CVE que se va a recuperar. Todos los resultados tendrán una puntuación CVE igual o mayor que el valor especificado. | Valor predeterminado = 0 . |
Opcional |
deviceIds | Lista separada por comas de identificadores de dispositivo de los que desea mostrar los resultados. | Por ejemplo: 1232,34,2,456 |
Opcional |
Pasos siguientes
Para obtener más información, consulte:
- Información general de referencia de la API de Defender para IoT
- Tutorial de : Integración de ServiceNow con Microsoft Defender para IoT