Share via


Referencia de la API de Defender para IoT

En esta sección, se describen las API públicas admitidas por Microsoft Defender para IoT. Las API de Defender para IoT se rigen por la licencia de API de Microsoft y Términos de uso.

Use las API de Defender para IoT para acceder a los datos detectados por los sensores y las consolas de administración locales, y para realizar acciones con esos datos.

Las conexiones de las API están protegidas mediante SSL.

Generación de un token de acceso de API

Muchas API de Defender para IoT necesitan un token de acceso. Los tokens de acceso no son necesarios en las API de autenticación.

Para generar un token:

  1. En la ventana Configuración del sistema, seleccione Integraciones>Tokens de acceso.

  2. Seleccione Generar token.

  3. En Descripción, describa para qué es el nuevo token y seleccione Generar.

  4. Se muestra el token de acceso. Cópielo, ya que no se volverá a mostrar.

  5. Seleccione Finalizar.

    • Los tokens que cree aparecerán en el cuadro de diálogo Tokens de acceso. Usado indica la última vez que se recibió una llamada externa con este token.

    • N/A en el campo Usado indica que la conexión entre el sensor y el servidor conectado no funciona.

Después de generar un token, agregue un encabezado HTTP titulado Authorization a su solicitud y establezca su valor en el token que ha generado.

Referencia de las versiones de las API de sensores

Versión API admitidas
Ninguna versión Autenticación y administración de contraseñas:
- set_password (cambio de contraseña)
- set_password_by_admin (actualización de la contraseña de un usuario por el administrador)
- validation (validación de las credenciales del usuario)
Novedades de la versión 1 Inventario:
- connections (recuperación de la información de conexión del dispositivo)
- cves (recuperación de la información de los CVE)
- devices (recuperación de la información de los dispositivos)

Alertas:
- alerts (recuperación de información de las alertas)
- events (recuperación de información de la escala de tiempo)

Vulnerabilidades:
- operational (recuperación de vulnerabilidades operativas)
- devices (recuperación de información de vulnerabilidades de los dispositivos)
- mitigation (recuperación de los pasos de mitigación)
- security (recuperación de las vulnerabilidades de seguridad)
Novedades de la versión 2 Alertas:
- Actualizaciones en alerts (recuperación de información de las alertas)

Referencia de las versiones de API de la consola de administración local

Versión API existentes
Ninguna versión Autenticación y administración de contraseñas:
- set_password (cambio de contraseña)
- set_password_by_admin (actualización de la contraseña de usuario por el administrador del sistema)
- validation (autenticación de las credenciales del usuario)
Novedades de la versión 1 Sites
- appliances (administración de los dispositivos de sensores de OT)
Inventario:
- devices (recuperación de información de todos los dispositivos)

Alertas:
- alerts (recuperación de información de las alertas)
- maintenanceWindow (creación de exclusiones de alertas)
Novedades de la versión 2 Alertas:
- Actualizaciones en alerts (recuperación de información de las alertas)
- pcap (solicitud de PCAP de alerta)
Novedades de la versión 3 API de integración:
- connections (obtención de las conexiones del dispositivo)
- device (obtención de detalles de un dispositivo)
- devicecves (obtención de los CVE de los dispositivos)
- devices (creación y actualización de dispositivos)
- deleteddevices (obtención de dispositivos eliminados)
- sensors (obtención de sensores)

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.

Si simplemente quiere consultar los datos, use mejor las API normales que no son de integración en una consola de administración local para consultar los datos de todos los dispositivos o en un sensor específico para consultar solo los datos de los dispositivos de ese sensor.

Tiempo Epoch

En todos los valores de marca de tiempo de Defender para IoT, el tiempo Epoch es 1/1/1970.

Pasos siguientes

Para más información, consulte: