Dokumentacja interfejsu API integracji dla lokalnych konsol zarządzania (publiczna wersja zapoznawcza)
W tym artykule wymieniono interfejsy API obsługiwane do integracji Microsoft Defender dla IoT z usługami partnerskimi.
Na przykład ten interfejs API jest obecnie implementowany za pomocą samouczka: integrowanie usługi ServiceNow z Microsoft Defender dla IoT za pośrednictwem łącznika ServiceNow Service Graph Connector for Defender for IoT.
Uwaga
Interfejsy API integracji są przeznaczone do ciągłego uruchamiania i tworzenia stale działającego 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 dla lokalnej konsoli zarządzania w celu wykonywania zapytań dotyczących wszystkich urządzeń lub konkretnego 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 dla IoT).
Identyfikator 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.
Identyfikator URI: /external/v3/integration/devices/<timestamp>
Parametry identyfikatora URI:
Nazwa | Opis | Przykład | Wymagane/opcjonalne |
---|---|---|---|
Sygnatury czasowej | Godzina rozpoczęcia, od której są zwracane wyniki( w milisekundach czasu epoki i w strefie czasowej UTC). | /external/v3/integration/devices/1664781014000 |
Wymagane |
GET
Parametry zapytania:
Nazwa | Opis | Przykład | Wymagane/opcjonalne |
---|---|---|---|
sensorId | Zwracaj tylko urządzenia widoczne przez określony czujnik. Użyj wartości identyfikatora z wyników interfejsu API czujników (Pobierz czujniki). | 1 |
Opcjonalne |
notificationType | Określa typy urządzeń do zwrócenia. Obsługiwane wartości: - 0 : Zarówno zaktualizowane, jak i nowe urządzenia (ustawienie domyślne). - 1 : Tylko nowe urządzenia. - 2 : Tylko zaktualizowane urządzenia. |
2 |
Opcjonalne |
Strona | Definiuje liczbę, w której rozpoczyna się numeracja stron wyników. Na przykład 0 = pierwsza strona to 0. Wartość domyślna = 0 |
0 |
Opcjonalne |
Rozmiar | Definiuje rozmiar strony. Wartość domyślna = 50 |
75 |
Opcjonalne |
połączenia (pobieranie połączeń urządzeń)
Ten interfejs API zwraca dane dotyczące wszystkich połączeń urządzeń, które zostały zaktualizowane po danym znaczniku czasu.
Identyfikator URI: /external/v3/integration/connections/<timestamp>
Parametry identyfikatora URI:
Nazwa | Opis | Przykład | Wymagane/opcjonalne |
---|---|---|---|
Sygnatury czasowej | Godzina rozpoczęcia, od której są zwracane wyniki( w milisekundach czasu epoki i w strefie czasowej UTC). | /external/v3/integration/devices/1664781014000 |
Wymagane |
GET
Parametry zapytania:
Nazwa | Opis | Przykład | Wymagane/opcjonalne |
---|---|---|---|
Strona | Definiuje liczbę, w której rozpoczyna się numeracja stron wyników. Na przykład 0 = pierwsza strona to 0. Wartość domyślna = 0 |
0 |
Opcjonalne |
Rozmiar | Definiuje rozmiar strony. Wartość domyślna = 50 |
75 |
Opcjonalne |
urządzenie (pobieranie szczegółów dla urządzenia)
Ten interfejs API zwraca dane dotyczące określonego urządzenia dla danego identyfikatora urządzenia.
Identyfikator URI: /external/v3/integration/device/{deviceId}
GET
Parametry zapytania:
Nazwa | Opis | Przykład | Wymagane /Opcjonalne |
---|---|---|---|
Deviceid | Identyfikator żądanego urządzenia w lokalnej konsoli zarządzania | 1 |
Wymagane |
deleteddevices (Pobieranie usuniętych urządzeń)
Ten interfejs API zwraca listę identyfikatorów ostatnio usuniętych urządzeń z podanej sygnatury czasowej.
Identyfikator URI: /external/v3/integration/deleteddevices/
GET
Parametry identyfikatora URI:
Nazwa | Opis | Przykład | Wymagane /Opcjonalne |
---|---|---|---|
Sygnatury czasowej | Godzina rozpoczęcia, od której są zwracane wyniki w milisekundach z epoki i w strefie czasowej UTC. | /external/v3/integration/deleteddevices/1664781014000 |
Wymagane |
czujniki (Pobieranie czujników)
Ten interfejs API zwraca listę obiektów czujników dla połączonych czujników sieci OT.
Identyfikator URI: /external/v3/integration/sensors/
GET
Identyfikator URI: /sensors
Brak parametrów zapytania
devicecves (Pobieranie CVEs urządzenia)
Ten interfejs API zwraca listę aktywnych CVE dla wszystkich urządzeń, które zostały zaktualizowane od podanego znacznika czasu.
Identyfikator URI: /external/v3/integration/devicecves/
GET
Identyfikator URI: /external/v3/integration/devicecves/<timestamp>
Parametry identyfikatora URI
Nazwa | Opis | Przykład | Wymagane /Opcjonalne |
---|---|---|---|
Sygnatury czasowej | Godzina rozpoczęcia, od której są zwracane wyniki w milisekundach z epoki i w strefie czasowej UTC. | /external/v3/integration/devicecves/1664781014000 |
Wymagane |
Parametry zapytania
Nazwa | Opis | Przykład | Wymagane /Opcjonalne |
---|---|---|---|
Strona | Definiuje liczbę, w której rozpoczyna się numeracja strony wyników. |
0 = pierwsza strona to 0. Wartość domyślna = 0 |
Opcjonalne |
Rozmiar | Definiuje rozmiar strony. | Wartość domyślna = 50 |
Opcjonalne |
sensorId | Pokazuje wyniki z określonego czujnika, zgodnie z definicją podanego identyfikatora czujnika. | 1 |
Opcjonalne |
Ocena | Określa minimalną ocenę CVE, która ma zostać pobrana. Wszystkie wyniki będą miały wynik CVE równy lub większy niż podana wartość. | Wartość domyślna = 0 . |
Opcjonalne |
deviceIds | Rozdzielona przecinkami lista identyfikatorów urządzeń, z których chcesz wyświetlić wyniki. | Na przykład: 1232,34,2,456 |
Opcjonalne |
Następne kroki
Aby uzyskać więcej informacji, zobacz: