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 für IoT in Partnerdienste unterstützt werden.

Diese API wird z. B. derzeit mit Lernprogramm implementiert: Integrieren von ServiceNow in Microsoft Defender für IoT, über den ServiceNow Service Graph Connector für Defender für IoT.

Anmerkung

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.

Um einfach Daten abzufragen, verwenden Sie stattdessen die regulären NICHT-Integrations-APIs, um entweder eine lokale Verwaltungskonsole zum Abfragen aller Geräte oder für einen bestimmten Sensor, um Geräte nur von diesem Sensor abzufragen. Weitere Informationen finden Sie unter Defender für IoT-API-Referenz.

URI-: /external/v3/integration/

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
Zeitstempel-	Die Startzeit, aus der Ergebnisse zurückgegeben werden, in Millisekunden aus Epochenzeit und in UTC-Zeitzone.	/external/v3/integration/devices/1664781014000	Erforderlich

ERHALTEN

Abfrageparameter:

Name	Beschreibung	Beispiel	Erforderlich/Optional
sensorId-	Gibt nur Geräte zurück, die von einem bestimmten Sensor angezeigt werden. Verwenden Sie den ID-Wert aus den Ergebnissen der Sensoren (Abrufen von Sensoren)-API.	1	Wahlfrei
notificationType-	Bestimmt die Gerätetypen, die zurückgegeben werden sollen. Zu den unterstützten Werten gehören: - 0: Sowohl aktualisierte als auch neue Geräte (Standard). - 1: Nur neue Geräte. - 2: Nur aktualisierte Geräte.	2	Wahlfrei
Seite	Definiert die Zahl, an der die Seitennummerierung des Ergebnisses beginnt. Beispielsweise ist 0= erste Seite 0. Default = 0	0	Wahlfrei
Größe	Definiert die Seitengröße. Default = 50	75	Wahlfrei

Antwort-

Typ: JSON

Antwortfelder:

Name	Art	Nullable / Nicht nullable	Liste der Werte
u_count	Ganze Zahl	Lässt keine Nullwerte zu.	Die Anzahl der Objekte im vollständigen Resultset, einschließlich aller Seiten.
u_devices	JSON-Array von Geräteobjekten	Lässt keine Nullwerte zu.	Ein Array von Geräteobjekten, wie vom -Gerät definiert (Details für ein Gerät abrufen)-API.

Antwortbeispiel

{
    "u_devices": [{
        "u_operating_system": "",
        "u_ip_address_objects": [{
            "u_ip_address": "10.10.50.5",
            "u_guessed_mac_addresses": [{
                "u_mac_address": "00:02:a2:1f:1c:59"
            }]
        }],
        "u_zone": "asd",
        "u_name": "10.10.50.5",
        "u_mac_address_objects": [{
            "u_mac_address": "00:02:a2:1f:1c:59"
        }],
        "u_last_update": 1664782919000,
        "u_vendor": "HILSCHER GMBH",
        "u_cm_device_url": "https://<IP address>/#/sites/1/zones/1/devices-maps?devices=1",
        "u_sensor_ids": [{
            "u_sensor_id": 1
        }],
        "u_appliance": "Management console (CM)",
        "u_site": "asd",
        "u_device_type": {
            "u_category": "ICS",
            "u_purdue_layer": "Process Control",
            "u_name": "PLC"
        },
        "u_firmwares": [],
        "u_last_activity": 1664782791000,
        "u_purdue_layer": "N/A",
        "u_device_urls": [{
            "u_device_url": "https://<IP address>9/#/assets/highlight/1"
        }],
        "u_vlans": [{
            "u_vlan": "1"
        }],
        "u_groups": ["asd"],
        "u_first_discovered": 1664781051000,
        "u_id": 1,
        "u_protocol_objects": [{
            "u_protocol": "MODBUS"
        }]
    }, {
        "u_operating_system": "",
        "u_ip_address_objects": [{
            "u_ip_address": "10.10.20.10",
            "u_guessed_mac_addresses": [{
                "u_mac_address": "00:02:a2:1f:02:ba"
            }]
        }],
        "u_zone": "asd",
        "u_name": "10.10.20.10",
        "u_mac_address_objects": [{
            "u_mac_address": "00:02:a2:1f:02:ba"
        }],
        "u_last_update": 1664782859000,
        "u_vendor": "HILSCHER GMBH",
        "u_cm_device_url": "https://<IP address>/#/sites/1/zones/1/devices-maps?devices=50",
        "u_sensor_ids": [{
            "u_sensor_id": 1
        }],
        "u_appliance": "Management console (CM)",
        "u_site": "asd",
        "u_device_type": {
            "u_category": "ICS",
            "u_purdue_layer": "Process Control",
            "u_name": "PLC"
        },
        "u_firmwares": [],
        "u_last_activity": 1664782786000,
        "u_purdue_layer": "N/A",
        "u_device_urls": [{
            "u_device_url": "https://<IP address>9/#/assets/highlight/50"
        }],
        "u_vlans": [{
            "u_vlan": "1"
        }],
        "u_groups": ["asd"],
        "u_first_discovered": 1664781052000,
        "u_id": 50,
        "u_protocol_objects": [{
            "u_protocol": "MODBUS"
        }]
    }],
    "u_count": 204
}

cURL-Befehl

Typ: GET

API-:

curl -k -H "Authorization: <Authorization token>" "https://<IP address>/external/v3/integration/devices/<Timestamp>"

Beispiel:

curl -k -H "Authorization: 1234b734a9244d54ab8d40aedddcabcd" "https://127.0.0.1/external/v3/integration/devices/<Timestamp>"

Verbindungen (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
Zeitstempel-	Die Startzeit, aus der Ergebnisse zurückgegeben werden, in Millisekunden aus Epochenzeit und in UTC-Zeitzone.	/external/v3/integration/devices/1664781014000	Erforderlich

ERHALTEN

Abfrageparameter:

Name	Beschreibung	Beispiel	Erforderlich/Optional
Seite	Definiert die Zahl, an der die Seitennummerierung des Ergebnisses beginnt. Beispielsweise ist 0= erste Seite 0. Default = 0	0	Wahlfrei
Größe	Definiert die Seitengröße. Default = 50	75	Wahlfrei

Antwort-

Typ: JSON

Antwortfelder:

Name	Art	Nullable / Nicht nullable	Liste der Werte
u_count	Ganze Zahl	Lässt keine Nullwerte zu.	Die Anzahl der Objekte im vollständigen Resultset, einschließlich aller Seiten.
u_connections	JSON-Array von Verbindungsobjekten	Lässt keine Nullwerte zu.	Ein Array von Verbindungsobjekten

Verbindungsfelder

Name	Art	Nullable / Nicht nullable	Liste der Werte
u_appliance	Schnur	Lässt keine Nullwerte zu.	Der Name des Sensors, der die Verbindung ermittelt hat.
u_src_device_id	Ganze Zahl	Lässt keine Nullwerte zu.	Die ID des Quellgeräts der Verbindung.
u_src_device_name	Schnur	Lässt keine Nullwerte zu.	Der Name des Quellgeräts der Verbindung.
u_dest_device_id	Ganze Zahl	Lässt keine Nullwerte zu.	Die ID des Zielgeräts der Verbindung.
u_dest_device_name	Schnur	Lässt keine Nullwerte zu.	Der Name des Zielgeräts der Verbindung.
u_connection_type	Schnur	Lässt keine Nullwerte zu.	Eine der folgenden: One Way, Two Way, Multicast

Antwortbeispiel

{
    "u_count": 106,
    "u_connections": [{
        "u_src_device_id": 103,
        "u_dest_device_name": "10.10.10.16",
        "u_src_device_name": "10.10.10.18",
        "u_appliance": "Management console (CM)",
        "u_connection_type": "Two Way",
        "u_dest_device_id": 95
    }, {
        "u_src_device_id": 115,
        "u_dest_device_name": "10.10.10.64",
        "u_src_device_name": "10.10.10.30",
        "u_appliance": "Management console (CM)",
        "u_connection_type": "Two Way",
        "u_dest_device_id": 19
    }, {
        "u_src_device_id": 176,
        "u_dest_device_name": "10.10.45.7",
        "u_src_device_name": "10.10.45.100",
        "u_appliance": "Management console (CM)",
        "u_connection_type": "Two Way",
        "u_dest_device_id": 134
    },

cURL-Befehl

Typ: GET

API-:

curl -k -H "Authorization: <Authorization token>" "https://<IP address>/external/v3/integration/connections/1664781014000"

Beispiel:

curl -k -H "Authorization: 1234b734a9244d54ab8d40aedddcabcd" "https://127.0.0.1/external/v3/integration/connections/1664781014000"

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

Diese API gibt Daten zu einem bestimmten Gerät pro einer bestimmten Geräte-ID zurück.

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

ERHALTEN

Abfrageparameter:

Name	Beschreibung	Beispiel	Erforderlich/Optional
deviceId-	Die ID des angeforderten Geräts auf der lokalen Verwaltungskonsole	1	Erforderlich

Antwort-

Typ: JSON

Antwortfelder:

Name	Art	Nullable / Nicht nullable	Liste der Werte
u_id	Lange ganze Zahl	Lässt keine Nullwerte zu.	Die Geräte-ID auf der lokalen Verwaltungskonsole.
u_vendor	Schnur	Nullable	Der Herstellername des Geräts.
u_appliance	Schnur	Lässt keine Nullwerte zu.	Der Name des Sensors, der das Gerät erkannt hat.
u_mac_address_objects	JSON-Array von Zeichenfolgen	Lässt keine Nullwerte zu.	Ein Array von u_mac_address Werten, wobei die MAC-Adressen des Geräts aufgelistet werden.
u_groups	JSON-Array von Zeichenfolgen	Lässt keine Nullwerte zu.	Ein Array der Gruppen, die das Gerät enthalten.
u_site	Schnur	Lässt keine Nullwerte zu.	Der Name der Website des Geräts.
u_zone	Schnur	Lässt keine Nullwerte zu.	Der Name der Website des Geräts.
u_last_activity	DateTime	Lässt keine Nullwerte zu.	Der Zeitstempel des letzten Zeitpunkts, zu dem das Gerät aktiv war.
u_first_discovered	DateTime	Lässt keine Nullwerte zu.	Der Zeitstempel der Erkennungszeit des Geräts.
u_device_type	Schnur	Lässt keine Nullwerte zu.	Das Gerät typ
u_name	Schnur	Lässt keine Nullwerte zu.	Definiert den Gerätenamen.
u_ip_address_objects	JSON-Array von IP-Adressen	Lässt keine Nullwerte zu.	Array von IP-Adressen Objekten
u_mac_address_objects	JSON-Array von MAC-Adressen	Lässt keine Nullwerte zu.	Array von MAC-Adressen Objekten
u_protocol_objects	JSON-Array von Protokollen	Lässt keine Nullwerte zu.	Ein Array von Protokollobjekten
u_vlans	JSON-Array von VLAN-Objekten	Lässt keine Nullwerte zu.	Ein Array von VLAN--Objekten
u_purdue_layer	Schnur	Lässt keine Nullwerte zu.	Definiert die standardmäßige Purdue Layer- für diesen Gerätetyp.
u_sensor_ids	JSON-Array von Sensor-ID-Objekten	Lässt keine Nullwerte zu.	Ein Array von Sensor-ID Objekten
u_cm_device_url	Schnur	Lässt keine Nullwerte zu.	Die URL, die für den Zugriff auf das Gerät auf der lokalen Verwaltungskonsole verwendet wird.
u_device_urls	JSON-Array von URL-Objekten	Lässt keine Nullwerte zu.	Ein Array von Geräte-URL Objekten
u_last_update	Lange ganze Zahl	Lässt keine Nullwerte zu.	Definiert den Zeitstempel der letzten Aktualisierungszeit des Geräts.
u_firmwares	JSON-Array von Firmwareobjekten	Lässt keine Nullwerte zu.	Ein Array von Firmware--Objekten

felder ip_address_object

Name	Art	Nullable / Nicht nullable	Liste der Werte
u_ip_address	Schnur	Lässt keine Nullwerte zu.	Eine der IP-Adressen des Geräts
u_guessed_mac_address	Schnur	Lässt keine Nullwerte zu.	Die erratenen MAC-Adressen, die der IP-Adresse zugeordnet sind

felder mac_address_object

Name	Art	Nullable / Nicht nullable	Liste der Werte
u_mac_address	Schnur	Lässt keine Nullwerte zu.	Eine der MAC-Adressen des Geräts.

felder protocol_object

Name	Art	Nullable / Nicht nullable	Liste der Werte
u_protocol	Schnur	Lässt keine Nullwerte zu.	Eines der Protokolle, die vom Gerät verwendet werden.

felder vlan_object

Name	Art	Nullable / Nicht nullable	Liste der Werte
u_vlan	Schnur	Lässt keine Nullwerte zu.	Eines der VLANs, in denen das Gerät gefunden wird.

felder sensor_id_object

Name	Art	Nullable / Nicht nullable	Liste der Werte
u_sensor_id	Schnur	Lässt keine Nullwerte zu.	Die ID des Sensors, der das Gerät erkannt hat.

felder device_url_object

Name	Art	Nullable / Nicht nullable	Liste der Werte
u_device_url	Schnur	Lässt keine Nullwerte zu.	Die URLs, die zum Anzeigen des Geräts auf der lokalen Verwaltungskonsole verwendet werden.

felder firmware_object

Name	Art	Nullable / Nicht nullable	Liste der Werte
u_appliance	Schnur	Lässt keine Nullwerte zu.	Der Name der lokalen Verwaltungskonsole, die das Gerät verwaltet.
u_id	Lange ganze Zahl	Lässt keine Nullwerte zu.	Die ID des Geräts auf der lokalen Verwaltungskonsole
u_asset	Schnur	Lässt keine Nullwerte zu.	Der Name des Geräts
u_address	Schnur	Lässt keine Nullwerte zu.	Die Firmwareadresse des Geräts
u_module_address	Schnur	Nullable	Die Firmwaremoduladresse des Geräts
u_serial	Schnur	Nullable	Seriennummer des Geräts
u_model	Schnur	Nullable	Firmwaremodell des Geräts
u_version	Schnur	Nullable	Firmwareversion des Geräts
u_additional_data	Schnur	Nullable	Die firmwarespezifischen Zusätzlichen Daten des Geräts

Antwortbeispiel

[{
    "u_operating_system": "",
    "u_ip_address_objects": [{
        "u_ip_address": "10.10.50.5",
        "u_guessed_mac_addresses": [{
            "u_mac_address": "00:02:a2:1f:1c:59"
        }]
    }],
    "u_zone": "asd",
    "u_name": "10.10.50.5",
    "u_mac_address_objects": [{
        "u_mac_address": "00:02:a2:1f:1c:59"
    }],
    "u_last_update": 1664782919000,
    "u_vendor": "HILSCHER GMBH",
    "u_cm_device_url": "https://<IP address>/#/sites/1/zones/1/devices-maps?devices=1",
    "u_sensor_ids": [{
        "u_sensor_id": 1
    }],
    "u_appliance": "Management console (CM)",
    "u_site": "asd",
    "u_device_type": {
        "u_category": "ICS",
        "u_purdue_layer": "Process Control",
        "u_name": "PLC"
    },
    "u_firmwares": [],
    "u_last_activity": 1664782791000,
    "u_purdue_layer": "N/A",
    "u_device_urls": [{
        "u_device_url": "https://<IP address>9/#/assets/highlight/1"
    }],
    "u_vlans": [{
        "u_vlan": "1"
    }],
    "u_groups": ["asd"],
    "u_first_discovered": 1664781051000,
    "u_id": 1,
    "u_protocol_objects": [{
        "u_protocol": "MODBUS"
    }]
}]

cURL-Befehl

Typ: GET

API-:

curl -k -H "Authorization: <Authorization token>" "https://<IP address>/external/v3/integration/device/<device ID>"

Beispiel:

curl -k -H "Authorization: 1234b734a9244d54ab8d40aedddcabcd" "https://127.0.0.1/external/v3/integration/device/1"

deleteddevices (Get deleted devices)

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

URI-: /external/v3/integration/deleteddevices/

ERHALTEN

URI-Parameter:

Name	Beschreibung	Beispiel	Erforderlich/Optional
Zeitstempel-	Die Startzeit, aus der Ergebnisse zurückgegeben werden, in Millisekunden aus Epochenzeit und in UTC-Zeitzone.	/external/v3/integration/deleteddevices/1664781014000	Erforderlich

Antwort-

Typ: JSON-Array gelöschter Geräte

Gelöschte Gerätefelder:

Name	Art	Nullable / Nicht nullable	Liste der Werte
u_id	Lange ganze Zahl	Lässt keine Nullwerte zu.	Eine ID eines gelöschten Geräts

Antwortbeispiel

[{
    "u_id": 192
}, {
    "u_id": 66
}, {
    "u_id": 4
}, {
    "u_id": 22
}, {
    "u_id": 24
}]

cURL-Befehl

Typ: GET

API-:

curl -k -H "Authorization: <Authorization token>" "https://<IP address>/external/v3/integration/deleteddevices/<timestamp>"

Beispiel:

curl -k -H "Authorization: 1234b734a9244d54ab8d40aedddcabcd" "https://127.0.0.1/external/v3/integration/deleteddevices/1664781014000"

Sensoren (Sensoren abrufen)

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

URI-: /external/v3/integration/sensors/

ERHALTEN

URI-: /sensors

Keine Abfrageparameter

Antwort-

Typ: JSON

Antwortfelder:

Ein Array der folgenden Felder:

Name	Art	Nullable / Nicht nullable	Liste der Werte
u_id	Lange ganze Zahl	Lässt keine Nullwerte zu.	Definiert die interne Sensor-ID, die in den -Geräten (Erstellen und Aktualisieren von Geräten) API verwendet werden soll.
u_name	Schnur	Lässt keine Nullwerte zu.	Definiert den Namen der Sensor-Appliance.
u_interface_address	Schnur	Lässt keine Nullwerte zu.	Definiert die Netzwerkadresse der Sensor-Appliance.
u_connection_state	Schnur	Lässt keine Nullwerte zu.	Definiert den Verbindungsstatus des Geräts mit einer lokalen Verwaltungskonsole mit einem der folgenden Werte: - SYNCED: Die Verbindung ist erfolgreich. - OUT_OF_SYNC: Die lokale Verwaltungskonsole kann keine Vom Sensor empfangenen Daten verarbeiten. - TIME_DIFF_OFFSET: Zeitabweichung erkannt. Die lokale Verwaltungskonsole wurde vom Sensor getrennt. DISCONNECTED: Sensor kommuniziert nicht mit der Verwaltungskonsole. Überprüfen Sie die Netzwerkkonnektivität.
u_version	Schnur	Lässt keine Nullwerte zu.	Eine Zeichenfolgendarstellung der Softwareversion des Sensors.
u_alert_count	Lange ganze Zahl	Lässt keine Nullwerte zu.	Die aktuelle Anzahl der vom Sensor ausgelösten Warnungen.
u_device_count	Lange ganze Zahl	Lässt keine Nullwerte zu.	Die aktuelle Anzahl der vom Sensor erkannten Geräte.
u_unhandled_alert_count	Lange ganze Zahl	Lässt keine Nullwerte zu.	Die aktuelle Anzahl der aktuell nicht behandelten Warnungen auf dem Sensor.
u_is_activated	Boolesch	Lässt keine Nullwerte zu.	Definiert, ob der Sensor aktiviert wird.
u_data_intelligence_version	Schnur	Lässt keine Nullwerte zu.	Eine Zeichenfolgendarstellung der auf dem Sensor installierten Threat Intelligence-Version.
u_uid	Schnur	Lässt keine Nullwerte zu.	Definiert den global eindeutigen Bezeichner des Sensors.
u_zone_id	Lange ganze Zahl	Nullable	Definiert die Zone des Geräts.
u_is_in_learning_mode	Boolesch	Lässt keine Nullwerte zu.	Bestimmt, ob sich der Sensor im Lernmodus befindet.
u_remote_upgrade_stage	Schnur	Nullable	Definiert eine aktuelle Phase in einem Versionsaktualisierungsprozess als eine der folgenden: - UPLOADING - PREPARE_TO_INSTALL - STOPPING_PROCESSES - BACKING_UP_DATA - TAKING_SNAPSHOT - UPDATING_CONFIGURATION - UPDATING_DEPENDENCIES - UPDATING_LIBRARIES - PATCHING_DATABASES - STARTING_PROCESSES - VALIDATING_SYSTEM_SANITY - VALIDATION_SUCCEEDED_REBOOTING - SUCCESS - FAILURE - UPGRADE_STARTED - STARTING_INSTALLATION - INSTALLING_OPERATING_SYSTEM

Antwortbeispiel

[
  {
    u_connection_state: "SYNCED",
    u_uid: "fab58081-1fde-4d3f-8eea-9aa723abbd55",
    u_name: "Microsoft Defender for IoT",
    u_is_activated: true,
    u_alert_count: 6,
    u_device_count: 202,
    u_interface_address: "https://<IP address>9",
    u_zone_id: 1,
    u_data_intelligence_version: "May 26, 2022",
    u_is_in_learning_mode: false,
    u_unhandled_alert_count: 6,
    u_remote_upgrade_stage: "",
    u_id: 1,
    u_version: "22.2.5.7-r-2121448",
  },
];

cURL-Befehl

Typ: GET

API-:

curl -k -H "Authorization: <Authorization token>" "https://<IP Address>/external/v3/integration/sensors"

Beispiel:

curl -k -H "Authorization: 1234b734a9244d54ab8d40aedddcabcd" "https://127.0.0.1/external/v3/integration/sensors"

devicecves (Get device CVEs)

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/

ERHALTEN

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

URI-Parameter

Name	Beschreibung	Beispiel	Erforderlich/Optional
Zeitstempel-	Die Startzeit, aus der Ergebnisse zurückgegeben werden, in Millisekunden aus Epochenzeit und in UTC-Zeitzone.	/external/v3/integration/devicecves/1664781014000	Erforderlich

Abfrageparameter

Name	Beschreibung	Beispiel	Erforderlich/Optional
Seite	Definiert die Zahl, an der die Seitennummerierung des Ergebnisses beginnt.	0= erste Seite ist 0. Default = 0	Wahlfrei
Größe	Definiert die Seitengröße.	Default = 50	Wahlfrei
sensorId-	Zeigt Ergebnisse eines bestimmten Sensors an, wie durch die angegebene Sensor-ID definiert.	1	Wahlfrei
Bewertung	Bestimmt eine minimale CVE-Bewertung, die abgerufen werden soll. Alle Ergebnisse weisen eine CVE-Bewertung auf, die dem angegebenen Wert entspricht oder größer ist.	Default = 0.	Wahlfrei
deviceIds-	Eine durch Trennzeichen getrennte Liste von Geräte-IDs, aus denen Sie Ergebnisse anzeigen möchten.	Beispiel: 1232,34,2,456	Wahlfrei

Antwort-

Typ-: Anzahl und JSON-Array von Geräte-CVEs

Antwortfelder

Name	Art	Nullable / Nicht nullable	Liste der Werte
u_count	Ganze Zahl	Lässt keine Nullwerte zu.	Die Anzahl der Objekte im vollständigen Resultset, einschließlich aller Seiten.
u_device_cves	JSON-Array von CVE-Objekten des Geräts	Lässt keine Nullwerte zu.	Ein Array von Gerät CVE-Objekten

Geräte CVE-Felder

Name	Art	Nullable / Nicht nullable	Liste der Werte
u_id	Ganze Zahl	Lässt keine Nullwerte zu.	Die Geräte-ID in der lokalen Verwaltungskonsole.
u_name	Schnur	Lässt keine Nullwerte zu.	Der Name des Geräts.
u_ip_address_objects	JSON-Array von IP-Adressobjekten	Lässt keine Nullwerte zu.	Array von u_ip_address Werten, definieren die IP-Adressen der Geräte.
u_mac_address_objects	JSON-Array von MAC-Adressobjekten	Lässt keine Nullwerte zu.	Ein Array von u_mac_address Werten, wobei die MAC-Adressen des Geräts aufgelistet werden.
u_last_activity	Ganze Zahl	Lässt keine Nullwerte zu.	Zeitstempel des letzten Zeitstempels, zu dem der Datenverkehr von oder zum Gerät gesehen wurde.
u_last_update	Ganze Zahl	Lässt keine Nullwerte zu.	Der Zeitstempel der letzten Änderung einer Eigenschaft auf dem Gerät, einschließlich Benutzeränderungen und automatisierter Systemänderungen.
u_cves	JSON-Array von CVEs	Lässt keine Nullwerte zu.	Ein Array von CVE-Details Objekten

Anmerkung

Wenn Defender für IoT die MAC-Adresse einer seiner IP-Adressen sicher identifizieren kann, wird die MAC-Adresse direkt im Feld u_mac_address_objects zurückgegeben.

Wenn Defender für IoT nicht ganz sicher über eine MAC-Adresse ist, z. B. wenn der Datenverkehr über einen Router weitergeleitet wurde, wird die MAC-Adresse stattdessen im feld u_guessed_mac_address als Teil des JSON-Arrays von IP-Adressen zurückgegeben.

felder u_ip_address_objects

Name	Art	Nullable / Nicht nullable	Liste der Werte
u_ip_address	Schnur	Lässt keine Nullwerte zu.	Eine der IP-Adressen des Geräts
u_guessed_mac_address	JSON-Array von MAC-Adressobjekten	Lässt keine Nullwerte zu.	JSON-Array von MAC-Adressen

felder u_mac_address_objects

Name	Art	Nullable / Nicht nullable	Liste der Werte
u_mac_address	Schnur	Lässt keine Nullwerte zu.	Eine der MAC-Adressen des Geräts

felder u_cves

Name	Art	Nullable / Nicht nullable	Liste der Werte
u_address	Schnur	Lässt keine Nullwerte zu.	Adresse der spezifischen Schnittstelle mit der spezifischen Firmware, in der die CVE erkannt wurde.
u_cve_id	Schnur	Lässt keine Nullwerte zu.	Definiert die CVE-ID.
u_score	Schnur	Lässt keine Nullwerte zu.	Definiert die CVE-Risikobewertung
u_attack_vector	Schnur	Lässt keine Nullwerte zu.	Definiert den Angriffsvektor als einen der folgenden: ADJACENT_NETWORK, LOCAL, NETWORK
u_description	Schnur	Lässt keine Nullwerte zu.	Definiert die CVE-Beschreibung.

Antwortbeispiel

{
    "u_count": 2,
    "u_device_cves": [{
        "u_ip_address_objects": [{
            "u_ip_address": "192.168.1.127",
            "u_guessed_mac_addresses": [{
                "u_mac_address": "00:0f:38:67:4f:1c"
            }]
        }],
        "u_name": "192.168.1.127",
        "u_mac_address_objects": [{
            "u_mac_address": "00:0f:38:67:4f:1c"
        }],
        "u_last_update": 1664787209000,
        "u_last_activity": 1664782792000,
        "u_id": 135,
        "u_cves": [{
            "u_cve_id": "CVE-2015-2373",
            "u_score": "10.0",
            "u_ip_address": "192.168.1.127",
            "u_description": "The Remote Desktop Protocol (RDP) server service in Microsoft Windows 7 SP1, Windows 8, and Windows Server 2012 allows remote attackers to execute arbitrary code via a series of crafted packets, aka \"Remote Desktop Protocol (RDP) Remote Code Execution Vulnerability.\"",
            "u_attack_vector": "NETWORK"
        }, {
            "u_cve_id": "CVE-2015-1635",
            "u_score": "10.0",
            "u_ip_address": "192.168.1.127",
            "u_description": "HTTP.sys in Microsoft Windows 7 SP1, Windows Server 2008 R2 SP1, Windows 8, Windows 8.1, and Windows Server 2012 Gold and R2 allows remote attackers to execute arbitrary code via crafted HTTP requests, aka \"HTTP.sys Remote Code Execution Vulnerability.\"",
            "u_attack_vector": "NETWORK"
        }, {
            "u_cve_id": "CVE-2015-0014",
            "u_score": "10.0",
            "u_ip_address": "192.168.1.127",
            "u_description": "Buffer overflow in the Telnet service in Microsoft Windows Server 2003 SP2, Windows Vista SP2, Windows Server 2008 SP2 and R2 SP1, Windows 7 SP1, Windows 8, Windows 8.1, and Windows Server 2012 Gold and R2 allows remote attackers to execute arbitrary code via crafted packets, aka \"Windows Telnet Service Buffer Overflow Vulnerability.\"",
            "u_attack_vector": "NETWORK"
        }]
    }, {
        "u_ip_address_objects": [{
            "u_ip_address": "10.13.10.5",
            "u_guessed_mac_addresses": [{
                "u_mac_address": "00:05:f0:00:0f:cd"
            }]
        }],
        "u_name": "10.13.10.5",
        "u_mac_address_objects": [{
            "u_mac_address": "00:05:f0:00:0f:cd"
        }],
        "u_last_update": 1664787149000,
        "u_last_activity": 1664782792000,
        "u_id": 181,
        "u_cves": [{
            "u_cve_id": "CVE-2016-7182",
            "u_score": "10.0",
            "u_ip_address": "10.13.10.5",
            "u_description": "The Graphics component in Microsoft Windows Vista SP2; Windows Server 2008 SP2 and R2 SP1; Windows 7 SP1; Windows 8.1; Windows Server 2012 Gold and R2; Windows RT 8.1; Windows 10 Gold, 1511, and 1607; Office 2007 SP3; Office 2010 SP2; Word Viewer; Skype for Business 2016; Lync 2013 SP1; Lync 2010; Lync 2010 Attendee; and Live Meeting 2007 Console allows attackers to execute arbitrary code via a crafted True Type font, aka \"True Type Font Parsing Elevation of Privilege Vulnerability.\"",
            "u_attack_vector": "NETWORK"
        }, {
            "u_cve_id": "CVE-2016-3270",
            "u_score": "10.0",
            "u_ip_address": "10.13.10.5",
            "u_description": "The Graphics component in the kernel in Microsoft Windows Vista SP2; Windows Server 2008 SP2 and R2 SP1; Windows 7 SP1; Windows 8.1; Windows Server 2012 Gold and R2; Windows RT 8.1; and Windows 10 Gold, 1511, and 1607 allows local users to gain privileges via a crafted application, aka \"Win32k Elevation of Privilege Vulnerability.\"",
            "u_attack_vector": "NETWORK"
        }, {
            "u_cve_id": "CVE-2016-3266",
            "u_score": "10.0",
            "u_ip_address": "10.13.10.5",
            "u_description": "The kernel-mode drivers in Microsoft Windows Vista SP2, Windows Server 2008 SP2 and R2 SP1, Windows 7 SP1, Windows 8.1, Windows Server 2012 Gold and R2, Windows RT 8.1, and Windows 10 Gold, 1511, and 1607 allow local users to gain privileges via a crafted application, aka \"Win32k Elevation of Privilege Vulnerability,\" a different vulnerability than CVE-2016-3376, CVE-2016-7185, and CVE-2016-7211.",
            "u_attack_vector": "NETWORK"
        }]
    }]
}

cURL-Befehl

Typ: GET

API-:

curl -k -H "Authorization: <Authorization token>" "https://<IP Address>/external/v3/integration/devicecves/<timestamp>"

Beispiel:

curl -k -H "Authorization: 1234b734a9244d54ab8d40aedddcabcd" "https://127.0.0.1/external/v3/integration/devicecves/1664781014000"

Nächste Schritte

Weitere Informationen finden Sie unter:

• Übersicht über Defender für IoT-API
• Lernprogramm: Integrieren von ServiceNow in Microsoft Defender für IoT-