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.
Note
Les API d’intégration sont destinées à s’exécuter en continu et à créer un flux de données en cours d’exécution constant, par exemple pour interroger de nouvelles données à partir des cinq dernières minutes. Les API d’intégration retournent des données avec un horodatage.
Pour simplement interroger des données, utilisez plutôt les API régulières et non intégrées pour qu’une console de gestion locale interroge tous les appareils, soit pour un capteur spécifique pour interroger des appareils à partir de ce capteur uniquement. Pour plus d’informations, consultez informations de référence sur l’API Defender pour IoT.
URI: /external/v3/integration/
appareils (Créer 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 |
---|---|---|---|
horodatage | Heure de début à partir de laquelle les résultats sont retournés, en millisecondes de heure de l’époque et dans le fuseau horaire UTC. | /external/v3/integration/devices/1664781014000 |
Obligatoire |
AVOIR
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 des capteurs (Obtenir des capteurs) API. | 1 |
Optionnel |
notificationType | Détermine les types d’appareils à retourner. Les valeurs prises en charge sont les suivantes : - 0 : appareils mis à jour et nouveaux (par défaut). - 1 : seuls les nouveaux appareils. - 2 : seuls les appareils mis à jour. |
2 |
Optionnel |
page | Définit le nombre dans lequel commence la numérotation des pages de résultats. Par exemple, 0 = la première page est 0. Valeur par défaut = 0 |
0 |
Optionnel |
taille | Définit le dimensionnement de la page. Valeur par défaut = 50 |
75 |
Optionnel |
connexions (Obtenir des connexions d’appareil)
Cette API retourne des données sur toutes les connexions d’appareil qui ont été mises à jour après l’horodatage donné.
URI: /external/v3/integration/connections/<timestamp>
paramètres d’URI:
Nom | Description | Exemple | Obligatoire /Facultatif |
---|---|---|---|
horodatage | Heure de début à partir de laquelle les résultats sont retournés, en millisecondes de heure de l’époque et dans le fuseau horaire UTC. | /external/v3/integration/devices/1664781014000 |
Obligatoire |
AVOIR
paramètres de requête:
Nom | Description | Exemple | Obligatoire /Facultatif |
---|---|---|---|
page | Définit le nombre dans lequel commence la numérotation des pages de résultats. Par exemple, 0 = la première page est 0. Valeur par défaut = 0 |
0 |
Optionnel |
taille | Définit le dimensionnement de la page. Valeur par défaut = 50 |
75 |
Optionnel |
appareil (Obtenir les détails d’un appareil)
Cette API retourne des données sur un appareil spécifique par ID d’appareil donné.
URI: /external/v3/integration/device/{deviceId}
AVOIR
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 de l’horodatage fourni.
URI: /external/v3/integration/deleteddevices/
AVOIR
paramètres d’URI:
Nom | Description | Exemple | Obligatoire /Facultatif |
---|---|---|---|
horodatage | Heure de début à partir de laquelle les résultats sont retournés, en millisecondes de heure de l’époque 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 réseau OT connectés.
URI: /external/v3/integration/sensors/
AVOIR
URI: /sensors
Aucun paramètre de requête
devicecves (Get device CVEs)
Cette API retourne une liste d’EV actives pour tous les appareils qui ont été mis à jour depuis l’horodatage fourni.
URI: /external/v3/integration/devicecves/
AVOIR
URI: /external/v3/integration/devicecves/<timestamp>
Paramètres d’URI
Nom | Description | Exemple | Obligatoire /Facultatif |
---|---|---|---|
horodatage | Heure de début à partir de laquelle les résultats sont retournés, en millisecondes de heure de l’époque 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 nombre dans lequel commence la numérotation des pages de résultats. |
0 = la première page est 0. Valeur par défaut = 0 |
Optionnel |
taille | Définit le dimensionnement de la page. | Valeur par défaut = 50 |
Optionnel |
sensorId | Affiche les résultats d’un capteur spécifique, tel que défini par l’ID de capteur donné. | 1 |
Optionnel |
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 . |
Optionnel |
deviceIds | Liste séparée par des virgules des ID d’appareil dont vous souhaitez afficher les résultats. | Par exemple : 1232,34,2,456 |
Optionnel |
Étapes suivantes
Pour plus d’informations, consultez :
- Vue d’ensemble des informations de référence sur l’API Defender pour IoT
- tutoriel : Intégrer ServiceNow à Microsoft Defender pour IoT