Teilen über


Referenz für die Bestandsverwaltungs-APIs für OT-Überwachungssensoren

In diesem Artikel werden die APIs für die Gerätebestandsverwaltung aufgeführt, die für OT-Sensoren von Defender for IoT unterstützt werden.

connections (Abrufen von Geräteverbindungsinformationen)

Verwenden Sie diese API, um eine Liste aller Geräteverbindungen anzufordern.

URI: /api/v1/devices/connections

GET

Abfrageparameter

Definieren Sie beliebige der folgenden Abfrageparameter, um die zurückgegebenen Ergebnisse zu filtern. Wenn Sie keine Abfrageparameter festlegen, werden alle Geräteverbindungen zurückgegeben.

Name Beschreibung des Dataflows Beispiel Erforderlich/optional
discoveredBefore Numerisch. Dient zum Filtern der Ergebnisse, die vor einem bestimmten Zeitpunkt erkannt wurden. Der Zeitpunkt wird dabei in Millisekunden auf Basis der Epochenzeit sowie in der UTC-Zeitzone angegeben. /api/v1/devices/2/connections?discoveredBefore=<epoch> Optional
discoveredAfter Numerisch. Dient zum Filtern der Ergebnisse, die nach einem bestimmten Zeitpunkt erkannt wurden. Der Zeitpunkt wird dabei in Millisekunden auf Basis der Epochenzeit sowie in der UTC-Zeitzone angegeben. /api/v1/devices/2/connections?discoveredAfter=<epoch> Optional
lastActiveInMinutes Numerisch. Dient zum Filtern der Ergebnisse nach einem bestimmten Zeitrahmen, in dem Verbindungen aktiv waren. Wird rückwärts in Minuten ab der aktuellen Zeit definiert. /api/v1/devices/2/connections?lastActiveInMinutes=20 Optional

connections per device (Abrufen spezifischer Geräteverbindungsinformationen)

Verwenden Sie diese API, um eine Liste aller Verbindungen pro Gerät anzufordern.

URI: /api/v1/devices/<deviceID>/connections

GET

Pfadparameter

Name Beschreibung des Dataflows Beispiel Erforderlich/optional
deviceId Dient zum Abrufen der Verbindungen für das angegebene Gerät. /api/v1/devices/<deviceId>/connections Erforderlich

Abfrageparameter

Name Beschreibung des Dataflows Beispiel Erforderlich/optional
discoveredBefore Numerisch. Dient zum Filtern der Ergebnisse, die vor einem bestimmten Zeitpunkt erkannt wurden. Der Zeitpunkt wird dabei in Millisekunden auf Basis der Epochenzeit sowie in der UTC-Zeitzone angegeben. /api/v1/devices/2/connections?discoveredBefore=<epoch> Optional
discoveredAfter Numerisch. Dient zum Filtern der Ergebnisse, die nach einem bestimmten Zeitpunkt erkannt wurden. Der Zeitpunkt wird dabei in Millisekunden auf Basis der Epochenzeit sowie in der UTC-Zeitzone angegeben. /api/v1/devices/2/connections?discoveredAfter=<epoch> Optional
lastActiveInMinutes Numerisch. Dient zum Filtern der Ergebnisse nach einem bestimmten Zeitrahmen, in dem Verbindungen aktiv waren. Wird rückwärts in Minuten ab der aktuellen Zeit definiert. /api/v1/devices/2/connections?lastActiveInMinutes=20 Optional

cves (Abrufen von Informationen zu CVEs)

Mit dieser API können Sie eine absteigend nach CVE-Bewertung sortierte Liste aller bekannten CVEs anfordern, die auf Geräten im Netzwerk erkannt wurden.

URI: /api/v1/devices/cves

GET

Beispiel: /api/v1/devices/cves

Definieren Sie beliebige der folgenden Abfrageparameter, um die zurückgegebenen Ergebnisse zu filtern.

Name Beschreibung des Dataflows Beispiel Erforderlich/optional
top Numerisch. Bestimmt, wie viele CVEs mit den höchsten Bewertungen für jede Geräte-IP-Adresse abgerufen werden sollen. /api/v1/devices/cves?top=50

/api/v1/devices/<ipAddress>/cves?top=50
Optional. Standardwert: 100

cves per IP address (Abrufen bestimmter Informationen zu CVEs)

Mit dieser API können Sie eine Liste aller bekannten CVEs anfordern, die auf Geräten im Netzwerk für eine bestimmte IP-Adresse erkannt werden.

URI: /api/v1/devices/cves

GET

Beispiel: /api/v1/devices/cves

Pfadparameter

Name Beschreibung des Dataflows Beispiel Erforderlich/optional
ipAddress Dient zum Abrufen von CVEs für die angegebene IP-Adresse. /api/v1/devices/<ipAddress>/cves Erforderlich

Definieren Sie den folgenden Abfrageparameter, um die zurückgegebenen Ergebnisse zu filtern:

Name Beschreibung des Dataflows Beispiel Erforderlich/optional
top Numerisch. Bestimmt, wie viele CVEs mit den höchsten Bewertungen für jede Geräte-IP-Adresse abgerufen werden sollen. /api/v1/devices/cves?top=50

/api/v1/devices/<ipAddress>/cves?top=50
Optional. Standardwert: 100

devices (Abrufen von Geräteinformationen)

Verwenden Sie diese API, um eine Liste aller Geräte anzufordern, die von diesem Sensor erkannt wurden.

URI: api/v1/devices/

GET

Query parameter (Abfrageparameter)

Definieren Sie den folgenden Abfrageparameter, um die zurückgegebenen Ergebnisse zu filtern: Wenn Sie keine Abfrageparameter festlegen, werden alle Geräteverbindungen zurückgegeben.

Name Beschreibung des Dataflows Beispiel Erforderlich/optional
authorized Boolesch:

- true: Filtert nur nach Daten auf autorisierten Geräten.
- false: Filtert nur nach Daten auf nicht autorisierten Geräten.
/api/v1/devices/ Optional

Nächste Schritte

Weitere Informationen finden Sie in der Übersicht zur API-Referenz – Defender for IoT.