Partager via


Informations de référence sur l’API d’intégration pour les consoles de gestion locales (préversion publique)

Cet article répertorie les API prises en charge pour l’intégration de Microsoft Defender pour IoT avec les services partenaires.

Par exemple, cette API est actuellement implémentée avec Tutoriel : Intégrer ServiceNow à Microsoft Defender pour IoT, via le connecteur ServiceNow Service Graph pour Defender pour IoT.

Notes

Les API d’intégration sont destinées à s’exécuter en continu et à créer un flux de données constant, par exemple pour interroger de nouvelles données au cours des cinq dernières minutes. Les API d’intégration retournent des données avec un timestamp.

Pour simplement interroger des données, utilisez plutôt les API normales et non intégrées pour une console de gestion locale pour interroger tous les appareils, ou pour un capteur spécifique pour interroger uniquement les appareils à partir de ce capteur. Pour plus d’informations, consultez Référence de l’API Defender pour IoT.

URI : /external/v3/integration/

appareils (Créer, supprimer et mettre à jour des appareils)

Cette API retourne des données sur tous les appareils mis à jour après l’horodatage donné.

URI : /external/v3/integration/devices/<timestamp>

Paramètres d’URI :

Nom Description Exemple Obligatoire/facultatif
timestamp Heure de début à partir de laquelle les résultats sont retournés, en millisecondes à partir de l’heure Epoch et dans le fuseau horaire UTC. /external/v3/integration/devices/1664781014000 Obligatoire

GET

Paramètres de requête :

Nom Description Exemple Obligatoire/facultatif
sensorId Retournez uniquement les appareils vus par un capteur spécifique. Utilisez la valeur d’ID des résultats de l’API capteurs (Obtenir des capteurs). 1 Facultatif
notificationType Détermine les types d’appareils à retourner. Les valeurs prises en charge sont :
- 0 : à la fois les nouveaux appareils et les appareils mis à jour (par défaut).
- 1 : uniquement les nouveaux appareils.
- 2 : uniquement les appareils mis à jour.
2 Facultatif
page Définit le numéro auquel commence la numérotation de la page de résultats. Par exemple, 0= la première page est 0.
Valeur par défaut = 0
0 Facultatif
size Définit le dimensionnement de page. Valeur par défaut = 50 75 Facultatif

connexions (Obtenir des connexions d’appareil)

Cette API retourne des données sur toutes les connexions des appareils mis à jour après l’horodatage donné.

URI : /external/v3/integration/connections/<timestamp>

Paramètres d’URI :

Nom Description Exemple Obligatoire/facultatif
timestamp Heure de début à partir de laquelle les résultats sont retournés, en millisecondes à partir de l’heure Epoch et dans le fuseau horaire UTC. /external/v3/integration/devices/1664781014000 Obligatoire

GET

Paramètres de requête :

Nom Description Exemple Obligatoire/facultatif
page Définit le numéro auquel commence la numérotation de la page de résultats. Par exemple, 0= la première page est 0.
Valeur par défaut = 0
0 Facultatif
size Définit le dimensionnement de page. Valeur par défaut = 50 75 Facultatif

appareil (Obtenir des détails pour un appareil)

Cette API renvoie des données sur un appareil spécifique par ID d’appareil donné.

URI : /external/v3/integration/device/{deviceId}

GET

Paramètres de requête :

Nom Description Exemple Obligatoire/facultatif
deviceId ID de l’appareil demandé sur la console de gestion locale 1 Obligatoire

deleteddevices (Obtenir les appareils supprimés)

Cette API retourne une liste d’ID d’appareils récemment supprimés, à partir du timestamp fourni.

URI : /external/v3/integration/deleteddevices/

GET

Paramètres d’URI :

Nom Description Exemple Obligatoire/facultatif
timestamp Heure de début à partir de laquelle les résultats sont retournés, en millisecondes à partir de l’heure Epoch et dans le fuseau horaire UTC. /external/v3/integration/deleteddevices/1664781014000 Obligatoire

capteurs (Obtenir des capteurs)

Cette API retourne une liste d’objets de capteur pour les capteurs de réseau OT connectés.

URI : /external/v3/integration/sensors/

GET

URI : /sensors

Pas de paramètres de requête

devicecves (Obtenir les CVE d’appareil)

Cette API retourne la liste des CVE actifs pour tous les appareils qui ont été mis à jour depuis le timestamp fourni.

URI : /external/v3/integration/devicecves/

GET

URI : /external/v3/integration/devicecves/<timestamp>

Paramètres URI

Nom Description Exemple Obligatoire/facultatif
timestamp Heure de début à partir de laquelle les résultats sont retournés, en millisecondes à partir de l’heure Epoch et dans le fuseau horaire UTC. /external/v3/integration/devicecves/1664781014000 Obligatoire

Paramètres de requête

Nom Description Exemple Obligatoire/facultatif
page Définit le numéro auquel commence la numérotation de la page de résultats. 0= la première page est 0.
Valeur par défaut = 0
Facultatif
size Définit le dimensionnement de page. Valeur par défaut = 50 Facultatif
sensorId Affiche les résultats d’un capteur spécifique, tel que défini par l’ID de capteur donné. 1 Facultatif
score Détermine un score CVE minimal à récupérer. Tous les résultats auront un score CVE égal ou supérieur à la valeur donnée. Valeur par défaut = 0. Facultatif
deviceIds Une liste séparée par des virgules d’ID d’appareil à partir de laquelle vous souhaitez afficher les résultats. Par exemple : 1232,34,2,456 Facultatif

Étapes suivantes

Pour plus d'informations, consultez les pages suivantes :