Referenční informace k rozhraní API pro integraci pro místní konzoly pro správu (Public Preview)
Tento článek obsahuje seznam rozhraní API podporovaných pro integraci Microsoft Defenderu pro IoT s partnerskými službami.
Toto rozhraní API je například aktuálně implementované s Kurz: Integrace ServiceNow sv programu Microsoft Defender for IoT prostřednictvím konektoru ServiceNow Service Graph pro Defender pro IoT.
Poznámka
Rozhraní API pro integraci mají běžet nepřetržitě a vytvářet neustále spuštěný datový proud, jako je dotazování na nová data z posledních pěti minut. Rozhraní API pro integraci vrací data s časovým razítkem.
Pokud chcete jednoduše dotazovat data, použijte místo toho běžná rozhraní API bez integrace, ať už místní konzola pro správu k dotazování na všechna zařízení, nebo pro konkrétní senzor k dotazování zařízení pouze z daného senzoru. Další informace najdete v referenčních informacích krozhraní API
identifikátoru URI: /external/v3/integration/
zařízení (vytvoření a aktualizace zařízení)
Toto rozhraní API vrátí data o všech zařízeních, která byla aktualizována po daném časovém razítku.
identifikátoru URI: /external/v3/integration/devices/<timestamp>
parametry identifikátoru URI:
Jméno | Popis | Příklad | Povinné nebo volitelné |
---|---|---|---|
časové razítko | Počáteční čas, ze kterého se vrátí výsledky, v milisekundách od epochového času a v časovém pásmu UTC. | /external/v3/integration/devices/1664781014000 |
Požadovaný |
DOSTAT
- žádost
-
odpovědi
- příkazu cURL
parametry dotazu:
Jméno | Popis | Příklad | Povinné nebo volitelné |
---|---|---|---|
sensorId | Vrátí jenom zařízení, která vidí konkrétní senzor. Použijte hodnotu ID z výsledků senzorů (Získat senzory) API. | 1 |
Volitelný |
notificationType | Určuje typy zařízení, která se mají vrátit. Mezi podporované hodnoty patří: - 0 : Aktualizovaná i nová zařízení (výchozí). - 1 : Pouze nová zařízení. - 2 : Pouze aktualizovaná zařízení. |
2 |
Volitelný |
stránky |
Definuje číslo, na kterém začíná číslování výsledné stránky. Například 0 = první stránka je 0. Výchozí = 0 |
0 |
Volitelný |
velikosti |
Definuje velikost stránky. Výchozí = 50 |
75 |
Volitelný |
připojení (získání připojení zařízení)
Toto rozhraní API vrátí data o všech připojeních zařízení, která byla aktualizována po daném časovém razítku.
identifikátoru URI: /external/v3/integration/connections/<timestamp>
parametry identifikátoru URI:
Jméno | Popis | Příklad | Povinné nebo volitelné |
---|---|---|---|
časové razítko | Počáteční čas, ze kterého se vrátí výsledky, v milisekundách od epochového času a v časovém pásmu UTC. | /external/v3/integration/devices/1664781014000 |
Požadovaný |
DOSTAT
- žádost
-
odpovědi
- příkazu cURL
parametry dotazu:
Jméno | Popis | Příklad | Povinné nebo volitelné |
---|---|---|---|
stránky |
Definuje číslo, na kterém začíná číslování výsledné stránky. Například 0 = první stránka je 0. Výchozí = 0 |
0 |
Volitelný |
velikosti |
Definuje velikost stránky. Výchozí = 50 |
75 |
Volitelný |
(Získání podrobností o zařízení)
Toto rozhraní API vrací data o konkrétním zařízení podle daného ID zařízení.
identifikátoru URI: /external/v3/integration/device/{deviceId}
DOSTAT
- žádost
-
odpovědi
- příkazu cURL
parametry dotazu:
Jméno | Popis | Příklad | Povinné nebo volitelné |
---|---|---|---|
id zařízení | ID požadovaného zařízení v místní konzole pro správu | 1 |
Požadovaný |
odstraněná zařízení (získání odstraněných zařízení)
Toto rozhraní API vrátí seznam ID nedávno odstraněných zařízení ze zadaného časového razítka.
identifikátoru URI: /external/v3/integration/deleteddevices/
DOSTAT
- žádost
-
odpovědi
- příkazu cURL
parametry identifikátoru URI:
Jméno | Popis | Příklad | Povinné nebo volitelné |
---|---|---|---|
časové razítko | Počáteční čas, ze kterého se vrátí výsledky, v milisekundách od epochového času a v časovém pásmu UTC. | /external/v3/integration/deleteddevices/1664781014000 |
Požadovaný |
senzory (získání senzorů)
Toto rozhraní API vrátí seznam objektů senzorů pro připojené síťové senzory OT.
identifikátoru URI: /external/v3/integration/sensors/
DOSTAT
- žádost
-
odpovědi
- příkazu cURL
identifikátoru URI: /sensors
Žádné parametry dotazu
devicecves (Získání cves zařízení)
Toto rozhraní API vrátí seznam aktivních cves pro všechna zařízení, která byla aktualizována od zadaného časového razítka.
identifikátoru URI: /external/v3/integration/devicecves/
DOSTAT
- žádost
-
odpovědi
- příkazu cURL
identifikátoru URI: /external/v3/integration/devicecves/<timestamp>
Parametry identifikátoru URI
Jméno | Popis | Příklad | Povinné nebo volitelné |
---|---|---|---|
časové razítko | Počáteční čas, ze kterého se vrátí výsledky, v milisekundách od epochového času a v časovém pásmu UTC. | /external/v3/integration/devicecves/1664781014000 |
Požadovaný |
Parametry dotazu
Jméno | Popis | Příklad | Povinné nebo volitelné |
---|---|---|---|
stránky |
Definuje číslo, na kterém začíná číslování výsledné stránky. |
0 = první stránka je 0. Výchozí = 0 |
Volitelný |
velikosti |
Definuje velikost stránky. | Výchozí = 50 |
Volitelný |
sensorId | Zobrazuje výsledky z konkrétního senzoru, jak je definováno daným ID senzoru. | 1 |
Volitelný |
skóre | Určuje minimální skóre CVE, které se má načíst. Všechny výsledky budou mít skóre CVE stejné nebo větší než daná hodnota. | Výchozí = 0 . |
Volitelný |
id zařízení | Seznam ID zařízení oddělených čárkami, ze kterých chcete zobrazit výsledky. | Příklad: 1232,34,2,456 |
Volitelný |
Další kroky
Další informace najdete tady:
- Přehled referenčních informací k rozhraní Defender for IoT API
- Kurz : Integrace ServiceNow s Microsoft Defenderem pro IoT