Freigeben über


Integrations-API-Referenz für lokale Verwaltungskonsolen (öffentliche Vorschau)

In diesem Artikel werden die APIs aufgeführt, die für die Integration von Microsoft Defender for IoT mit Partnerdiensten unterstützt werden.

Diese API wird derzeit beispielsweise mit Tutorial: Integrieren von ServiceNow in Microsoft Defender for IoT über den ServiceNow Service Graph Connector für Defender für IoT implementiert.

Hinweis

Integrations-APIs sollen kontinuierlich ausgeführt werden und einen ständig ausgeführten Datenstrom erstellen, z. B. zum Abfragen neuer Daten aus den letzten fünf Minuten. Integrations-APIs geben Daten mit einem Zeitstempel zurück.

Wenn Sie Daten einfach abfragen möchten, verwenden Sie stattdessen die regulären, nicht integrierten APIs: entweder für eine lokale Verwaltungskonsole zum Abfragen aller Geräte oder für einen bestimmten Sensor zum Abfragen von Geräten nur von diesem Sensor. Weitere Informationen finden Sie unter Referenz zur Defender for IoT-API.

URI: /external/v3/integration/

devices (Geräte erstellen und aktualisieren)

Diese API gibt Daten zu allen Geräten zurück, die nach dem angegebenen Zeitstempel aktualisiert wurden.

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

URI-Parameter:

Name BESCHREIBUNG Beispiel Erforderlich/optional
timestamp Die Startzeit, ab der Ergebnisse zurückgegeben werden; in Millisekunden aus der Epochenzeit und in UTC-Zeitzone. /external/v3/integration/devices/1664781014000 Erforderlich

GET

Abfrageparameter:

Name BESCHREIBUNG Beispiel Erforderlich/optional
sensorId Gibt nur Geräte zurück, die von einem bestimmten Sensor erkannt werden. Verwendet den ID-Wert aus den Ergebnissen der API sensors (Sensoren abrufen). 1 Optional
notificationType Bestimmt die Typen von Geräten, die zurückgegeben werden sollen. Unterstützte Werte sind:
- 0: Sowohl aktualisierte als auch neue Geräte (Standard).
- 1: Nur neue Geräte.
- 2: Nur aktualisierte Geräte.
2 Optional
page Definiert die Zahl, ab der die Nummerierung der Ergebnisseiten beginnt. Beispiel: 0= erste Seite ist 0.
Standardwert: 0
0 Optional
size Definiert die Größe der Seite. Standardwert: 50 75 Optional

connections (Geräteverbindungen abrufen)

Diese API gibt Daten zu allen Geräteverbindungen zurück, die nach dem angegebenen Zeitstempel aktualisiert wurden.

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

URI-Parameter:

Name BESCHREIBUNG Beispiel Erforderlich/optional
timestamp Die Startzeit, ab der Ergebnisse zurückgegeben werden; in Millisekunden aus der Epochenzeit und in UTC-Zeitzone. /external/v3/integration/devices/1664781014000 Erforderlich

GET

Abfrageparameter:

Name BESCHREIBUNG Beispiel Erforderlich/optional
page Definiert die Zahl, ab der die Nummerierung der Ergebnisseiten beginnt. Beispiel: 0= erste Seite ist 0.
Standardwert: 0
0 Optional
size Definiert die Größe der Seite. Standardwert: 50 75 Optional

device (Details für ein Gerät abrufen)

Diese API gibt Daten zu einem bestimmten Gerät für eine bestimmte Geräte-ID zurück.

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

GET

Abfrageparameter:

Name BESCHREIBUNG Beispiel Erforderlich/optional
deviceId Die ID des angeforderten Geräts auf der lokalen Verwaltungskonsole 1 Erforderlich

deleteddevices (Gelöschte Geräte abrufen)

Diese API gibt eine Liste der IDs von zuletzt gelöschten Geräten aus dem angegebenen Zeitstempel zurück.

URI: /external/v3/integration/deleteddevices/

GET

URI-Parameter:

Name BESCHREIBUNG Beispiel Erforderlich/optional
timestamp Die Startzeit, ab der Ergebnisse zurückgegeben werden; in Millisekunden aus der Epochenzeit und in UTC-Zeitzone. /external/v3/integration/deleteddevices/1664781014000 Erforderlich

sensors (Sensoren abrufen)

Diese API gibt eine Liste von Sensorobjekten für verbundene OT-Netzwerksensoren zurück.

URI: /external/v3/integration/sensors/

GET

URI: /sensors

Keine Abfrageparameter

devicecves (Geräte-CVEs abrufen)

Diese API gibt eine Liste aktiver CVEs für alle Geräte zurück, die seit dem angegebenen Zeitstempel aktualisiert wurden.

URI: /external/v3/integration/devicecves/

GET

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

URI-Parameter

Name BESCHREIBUNG Beispiel Erforderlich/optional
timestamp Die Startzeit, ab der Ergebnisse zurückgegeben werden; in Millisekunden aus der Epochenzeit und in UTC-Zeitzone. /external/v3/integration/devicecves/1664781014000 Erforderlich

Abfrageparameter

Name BESCHREIBUNG Beispiel Erforderlich/optional
page Definiert die Zahl, ab der die Nummerierung der Ergebnisseiten beginnt. 0= erste Seite ist 0.
Standardwert: 0
Optional
size Definiert die Größe der Seite. Standardwert: 50 Optional
sensorId Zeigt die Ergebnisse von einem bestimmten Sensor an, wie durch die angegebene Sensor-ID definiert. 1 Optional
score Bestimmt einen abzurufenden CVE-Mindestscore. Alle Ergebnisse haben einen CVE-Score, der gleich oder höher als der angegebene Wert ist. Standard = 0. Optional
deviceIds Eine durch Kommas getrennte Liste von Geräte-IDs, aus der Sie Ergebnisse anzeigen möchten. Beispiel: 1232,34,2,456 Optional

Nächste Schritte

Weitere Informationen finden Sie unter