Referencia de 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 servicios de asociados.
Por ejemplo, esta API se implementa actualmente con Tutorial: Integración de ServiceNow con Microsoft Defender para IoT, mediante el conector Service Graph de ServiceNow 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; por ejemplo, para consultar si hay nuevos datos en los últimos cinco minutos. Las API de integración devuelven datos con una marca de tiempo.
Para simplemente consultar 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 para que un sensor específico consulte solo los dispositivos desde ese sensor. Para obtener más información, consulte Referencia de 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 u opcional |
---|---|---|---|
timestamp | Hora de inicio a partir de la cual se devuelven los resultados, en milisegundos desde la hora de época y en la zona horaria UTC. | /external/v3/integration/devices/1664781014000 |
Obligatorio |
GET
Parámetros de consulta:
Nombre | Descripción | Ejemplo | Obligatorio u opcional |
---|---|---|---|
sensorId | Devuelve solo los dispositivos vistos por un sensor específico. Use el valor de identificador de los resultados de la API de sensores (Obtener sensores). | 1 |
Opcionales |
notificationType | Determina los tipos de dispositivos que se van a devolver. Los valores admitidos son: - 0 : tanto los dispositivos actualizados como los nuevos (valor predeterminado). - 1 : solo dispositivos nuevos. - 2 : solo dispositivos actualizados. |
2 |
Opcionales |
page | Define el número donde comienza la numeración de la página de resultados. Por ejemplo, 0 = la primera página es 0. Valor predeterminado = 0 |
0 |
Opcionales |
size | Define el dimensionamiento de la página. Valor predeterminado = 50 |
75 |
Opcionales |
conexiones (Obtención de conexiones de dispositivo)
Esta API devuelve datos sobre todos los dispositivos 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 u opcional |
---|---|---|---|
timestamp | Hora de inicio a partir de la cual se devuelven los resultados, en milisegundos desde la hora de época y en la zona horaria UTC. | /external/v3/integration/devices/1664781014000 |
Obligatorio |
GET
Parámetros de consulta:
Nombre | Descripción | Ejemplo | Obligatorio u opcional |
---|---|---|---|
page | Define el número donde comienza la numeración de la página de resultados. Por ejemplo, 0 = la primera página es 0. Valor predeterminado = 0 |
0 |
Opcionales |
size | Define el dimensionamiento de la página. Valor predeterminado = 50 |
75 |
Opcionales |
dispositivo (Obtener detalles de un dispositivo)
Esta API devuelve datos sobre un dispositivo específico por cada identificador de dispositivo determinado.
URI:/external/v3/integration/device/{deviceId}
GET
Parámetros de consulta:
Nombre | Descripción | Ejemplo | Obligatorio u 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/
GET
Parámetros de URI:
Nombre | Descripción | Ejemplo | Obligatorio u opcional |
---|---|---|---|
timestamp | Hora de inicio a partir de la cual se devuelven los resultados, en milisegundos desde la hora de época y en la 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/
GET
URI:/sensors
No hay parámetros de consulta
devicecves (Obtener CVE de dispositivo)
Esta API devuelve una lista de CVE activos para todos los dispositivos que se actualizaron desde la marca de tiempo proporcionada.
URI:/external/v3/integration/devicecves/
GET
URI:/external/v3/integration/devicecves/<timestamp>
Parámetros del identificador URI
Nombre | Descripción | Ejemplo | Obligatorio u opcional |
---|---|---|---|
timestamp | Hora de inicio a partir de la cual se devuelven los resultados, en milisegundos desde la hora de época y en la zona horaria UTC. | /external/v3/integration/devicecves/1664781014000 |
Obligatorio |
Parámetros de consulta
Nombre | Descripción | Ejemplo | Obligatorio u opcional |
---|---|---|---|
page | 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 |
Opcionales |
size | Define el dimensionamiento de la página. | Valor predeterminado = 50 |
Opcionales |
sensorId | Muestra los resultados de un sensor específico, tal y como se define en el id. de sensor especificado. | 1 |
Opcionales |
score | 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 . |
Opcionales |
deviceIds | Una lista separada por comas de id. de dispositivo de los que desea mostrar los resultados. | Por ejemplo: 1232,34,2,456 |
Opcionales |
Pasos siguientes
Para más información, consulte: