Dokumentacja interfejsu API integracji dla lokalnych konsol zarządzania (publiczna wersja zapoznawcza)
Artykuł
W tym artykule wymieniono interfejsy API obsługiwane do integracji usługi Microsoft Defender dla IoT z usługami partnerskimi.
Na przykład ten interfejs API jest obecnie implementowany przy użyciu Tutorial: Integrate ServiceNow with Microsoft Defender for IoT, via the ServiceNow Service Graph Connector for Defender for IoT (Integrowanie usługi ServiceNow z usługą Microsoft Defender dla IoT) za pośrednictwem łącznika ServiceNow Service Graph connector for Defender for IoT.
Nuta
Interfejsy API integracji są przeznaczone do ciągłego uruchamiania i tworzenia stale uruchomionego strumienia danych, takiego jak wykonywanie zapytań o nowe dane z ostatnich pięciu minut. Interfejsy API integracji zwracają dane ze znacznikiem czasu.
Aby po prostu wykonywać zapytania dotyczące danych, użyj zwykłych, niezwiązanych z integracją interfejsów API, aby użyć lokalnej konsoli zarządzania do wykonywania zapytań dotyczących wszystkich urządzeń lub dla określonego czujnika w celu wykonywania zapytań dotyczących urządzeń tylko z tego czujnika. Aby uzyskać więcej informacji, zobacz Defender for IoT API reference (Dokumentacja interfejsu API usługi Defender for IoT).
identyfikatora URI: /external/v3/integration/
urządzenia (tworzenie i aktualizowanie urządzeń)
Ten interfejs API zwraca dane dotyczące wszystkich urządzeń, które zostały zaktualizowane po danym znaczniku czasu.
Godzina rozpoczęcia, od której są zwracane wyniki( w milisekundach od czasu epoki i w strefie czasowej UTC.
/external/v3/integration/devices/1664781014000
Wymagane
POBIERZ
żądania
odpowiedzi
polecenia cURL
parametry zapytania:
Nazwa
Opis
Przykład
Wymagane/opcjonalne
sensorId
Zwracanie tylko urządzeń widocznych przez określony czujnik. Użyj wartości ID z wyników czujników (Pobierz czujniki) interfejsu API.
1
Fakultatywny
notificationType
Określa typy urządzeń do zwrócenia. Obsługiwane wartości to:
-
0: zarówno zaktualizowane, jak i nowe urządzenia (ustawienie domyślne).
-
1: tylko nowe urządzenia.
-
2: tylko zaktualizowane urządzenia.
2
Fakultatywny
strony
Definiuje liczbę, w której rozpoczyna się numeracja strony wyników. Na przykład 0= pierwsza strona to 0. Ustawienie domyślne = 0
Definiuje stan połączenia urządzenia z lokalną konsolą zarządzania przy użyciu jednej z następujących wartości:
-
ZSYNCHRONIZOWANE: połączenie zakończyło się pomyślnie.
-
OUT_OF_SYNC: lokalna konsola zarządzania nie może przetwarzać danych odebranych z czujnika.
-
TIME_DIFF_OFFSET: Wykryto dryf czasu. Lokalna konsola zarządzania została odłączona od czujnika. DISCONNECTED: Czujnik nie komunikuje się z konsolą zarządzania. Sprawdź łączność sieciową.
u_version
Struna
Nie można pustoć
Ciąg reprezentujący wersję oprogramowania czujnika.
u_alert_count
Długa liczba całkowita
Nie można pustoć
Bieżąca liczba alertów wyzwalanych przez czujnik.
u_device_count
Długa liczba całkowita
Nie można pustoć
Bieżąca liczba urządzeń wykrytych przez czujnik.
u_unhandled_alert_count
Długa liczba całkowita
Nie można pustoć
Bieżąca liczba aktualnie nieobsługiwanych alertów w czujniku.
u_is_activated
Boolowski
Nie można pustoć
Określa, czy czujnik jest aktywowany.
u_data_intelligence_version
Struna
Nie można pustoć
Ciąg reprezentujący wersję analizy zagrożeń zainstalowaną na czujniku.
u_uid
Struna
Nie można pustoć
Definiuje unikatowy identyfikator czujnika w skali globalnej.
u_zone_id
Długa liczba całkowita
Nullable
Zdefiniuj strefę urządzenia.
u_is_in_learning_mode
Boolowski
Nie można pustoć
Określa, czy czujnik jest w trybie uczenia.
u_remote_upgrade_stage
Struna
Nullable
Definiuje bieżący etap procesu aktualizacji wersji jako jeden z następujących elementów: - 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
Jeśli usługa Defender dla IoT może bezpiecznie zidentyfikować adres MAC jednego z jego adresów IP, adres MAC zostanie zwrócony bezpośrednio w polu u_mac_address_objects.
Jeśli usługa Defender dla IoT nie jest całkowicie pewna adresu MAC, na przykład jeśli ruch został kierowany za pośrednictwem routera, adres MAC jest zwracany w polu u_guessed_mac_address zamiast tego w ramach tablicy adresów IP JSON.
u_ip_address_objects pola
Nazwa
Typ
Dopuszczana do wartości null/nie dopuszczana do wartości null
Lista wartości
u_ip_address
Struna
Nie można pustoć
Jeden z adresów IP urządzenia
u_guessed_mac_address
Tablica JSON obiektów adresów MAC
Nie można pustoć
Tablica JSON adresów MAC
u_mac_address_objects pola
Nazwa
Typ
Dopuszczana do wartości null/nie dopuszczana do wartości null
Lista wartości
u_mac_address
Struna
Nie można pustoć
Jeden z adresów MAC urządzenia
u_cves pola
Nazwa
Typ
Dopuszczana do wartości null/nie dopuszczana do wartości null
Lista wartości
u_address
Struna
Nie można pustoć
Adres określonego interfejsu z określonym oprogramowaniem układowym, w którym wykryto cve.
u_cve_id
Struna
Nie można pustoć
Definiuje identyfikator CVE
u_score
Struna
Nie można pustoć
Definiuje ocenę ryzyka CVE
u_attack_vector
Struna
Nie można pustoć
Definiuje wektor ataku jako jeden z następujących elementów: ADJACENT_NETWORK, LOCAL, NETWORK
u_description
Struna
Nie można pustoć
Definiuje opis CVE
Przykład odpowiedzi
{
"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"
}]
}]
}