Integrációs API-referencia helyszíni felügyeleti konzolokhoz (nyilvános előzetes verzió)
Ez a cikk az IoT-hez készült Microsoft Defender partnerszolgáltatásokkal való integrálásához támogatott API-kat sorolja fel.
Ez az API például jelenleg az Oktatóanyag: A ServiceNow integrálása az IoT-hez készült Microsoft Defender szolgáltatással az IoT-hez készült Defender ServiceNow Service Graph-összekötőn keresztül érhető el.
Megjegyzés
Az integrációs API-k célja, hogy folyamatosan fussanak, és folyamatosan futó adatfolyamot hozzanak létre, például új adatok lekérdezéséhez az elmúlt öt percből. Az integrációs API-k időbélyeggel ad vissza adatokat.
Az adatok egyszerű lekérdezéséhez használja inkább a normál, nem integrációs API-kat, például egy helyszíni felügyeleti konzolt az összes eszköz lekérdezéséhez, vagy egy adott érzékelőt, amely csak az adott érzékelőtől kérdez le eszközöket. További információ: Az IoT-hez készült Defender API referenciája.
URI: /external/v3/integration/
eszközök (eszközök létrehozása és frissítése)
Ez az API az adott időbélyeg után frissített összes eszköz adatait adja vissza.
URI: /external/v3/integration/devices/<timestamp>
URI-paraméterek:
Név | Leírás | Példa | Kötelező/nem kötelező |
---|---|---|---|
Időbélyeg | Az eredmény visszaadási kezdő időpontja, ezredmásodpercben az alapidőszaktól és az UTC időzónától. | /external/v3/integration/devices/1664781014000 |
Kötelező |
GET
Lekérdezési paraméterek:
Név | Leírás | Példa | Kötelező/nem kötelező |
---|---|---|---|
sensorId | Csak az adott érzékelő által látott eszközöket adja vissza. Használja az érzékelők (Érzékelők lekérése) API eredményeiből származó azonosítóértéket. | 1 |
Választható |
notificationType | Meghatározza a visszaadni kívánt eszközök típusát. Támogatott értékei egyebek mellett a következők: - 0 : Mind a frissített, mind az új eszközök (alapértelmezett). - 1 : Csak az új eszközök. - 2 : Csak frissített eszközök. |
2 |
Választható |
Oldalala | Meghatározza azt a számot, ahol az eredményoldal számozása kezdődik. Az = első oldal például 0 0. Alapértelmezett = 0 |
0 |
Választható |
Méret | Meghatározza a lapméretezést. Alapértelmezett = 50 |
75 |
Választható |
kapcsolatok (eszközkapcsolatok lekérése)
Ez az API adatokat ad vissza az összes olyan eszközkapcsolatról, amely a megadott időbélyeg után frissült.
URI: /external/v3/integration/connections/<timestamp>
URI-paraméterek:
Név | Leírás | Példa | Kötelező/nem kötelező |
---|---|---|---|
Időbélyeg | Az eredmény visszaadási kezdő időpontja, ezredmásodpercben az alapidőszaktól és az UTC időzónától. | /external/v3/integration/devices/1664781014000 |
Kötelező |
GET
Lekérdezési paraméterek:
Név | Leírás | Példa | Kötelező/nem kötelező |
---|---|---|---|
Oldalala | Meghatározza azt a számot, ahol az eredményoldal számozása kezdődik. Az = első oldal például 0 0. Alapértelmezett = 0 |
0 |
Választható |
Méret | Meghatározza a lapméretezést. Alapértelmezett = 50 |
75 |
Választható |
device (Eszköz adatainak lekérése)
Ez az API egy adott eszközről ad vissza adatokat egy adott eszközazonosító alapján.
URI: /external/v3/integration/device/{deviceId}
GET
Lekérdezési paraméterek:
Név | Leírás | Példa | Kötelező/nem kötelező |
---|---|---|---|
Deviceid | A kért eszköz azonosítója a helyszíni felügyeleti konzolon | 1 |
Kötelező |
deleteddevices (Törölt eszközök lekérése)
Ez az API a legutóbb törölt eszközök azonosítóinak listáját adja vissza a megadott időbélyegből.
URI: /external/v3/integration/deleteddevices/
GET
URI-paraméterek:
Név | Leírás | Példa | Kötelező/ Nem kötelező |
---|---|---|---|
Időbélyeg | Az eredmény visszaadási kezdő időpontja, ezredmásodpercben az epoch idő és az UTC időzónában. | /external/v3/integration/deleteddevices/1664781014000 |
Kötelező |
érzékelők (Érzékelők lekérése)
Ez az API a csatlakoztatott OT hálózati érzékelők érzékelőobjektumainak listáját adja vissza.
URI: /external/v3/integration/sensors/
GET
URI: /sensors
Nincsenek lekérdezési paraméterek
devicecves (Eszköz cves-ek lekérése)
Ez az API az aktív CVE-k listáját adja vissza a megadott időbélyeg óta frissített összes eszközhöz.
URI: /external/v3/integration/devicecves/
GET
URI: /external/v3/integration/devicecves/<timestamp>
URI-paraméterek
Név | Leírás | Példa | Kötelező/ Nem kötelező |
---|---|---|---|
Időbélyeg | Az eredmény visszaadási kezdő időpontja, ezredmásodpercben az epoch idő és az UTC időzónában. | /external/v3/integration/devicecves/1664781014000 |
Kötelező |
Lekérdezési paraméterek
Név | Leírás | Példa | Kötelező/ Nem kötelező |
---|---|---|---|
Oldalala | Meghatározza azt a számot, ahol az eredményoldal számozása megkezdődik. | 0 = az első oldal 0. Alapértelmezett = 0 |
Választható |
Méret | Meghatározza a lapméretezést. | Alapértelmezett = 50 |
Választható |
sensorId | Egy adott érzékelő eredményeinek megjelenítése a megadott érzékelőazonosító alapján. | 1 |
Választható |
Pontszám | Meghatározza a lekérendő minimális CVE-pontszámot. Minden eredménynek a megadott értéknél egyenlő vagy annál nagyobb CVE-pontszáma lesz. | Alapértelmezett = 0 . |
Választható |
deviceIds | Azoknak az eszközazonosítóknak a vesszővel tagolt listája, amelyekből eredményeket szeretne megjeleníteni. | Például: 1232,34,2,456 |
Választható |
Következő lépések
További információkért lásd: