Delen via


Naslaginformatie over integratie-API's voor on-premises beheerconsoles (openbare preview)

Dit artikel bevat de API's die worden ondersteund voor het integreren van Microsoft Defender for IoT met partnerservices.

Deze API is momenteel bijvoorbeeld geïmplementeerd met Zelfstudie: ServiceNow integreren met Microsoft Defender for IoT, via de ServiceNow Service Graph Connector voor Defender for IoT.

Notitie

Integratie-API's zijn bedoeld om continu uit te voeren en een voortdurend actieve gegevensstroom te maken, zoals het opvragen van nieuwe gegevens uit de afgelopen vijf minuten. Integratie-API's retourneren gegevens met een tijdstempel.

Als u alleen query's wilt uitvoeren op gegevens, gebruikt u de reguliere, niet-integratie-API's, voor een on-premises beheerconsole om query's uit te voeren op alle apparaten of voor een specifieke sensor om alleen een query uit te voeren op apparaten van die sensor. Zie Defender for IoT API-naslaginformatievoor meer informatie.

URI-: /external/v3/integration/

apparaten (apparaten maken en bijwerken)

Deze API retourneert gegevens over alle apparaten die zijn bijgewerkt na de opgegeven tijdstempel.

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

URI-parameters:

Naam Beschrijving Voorbeeld Vereist/optioneel
tijdstempel De begintijd waaruit resultaten worden geretourneerd, in milliseconden van Epoch-tijd en in UTC-tijdzone. /external/v3/integration/devices/1664781014000 Vereist

TOEVOEGEN

queryparameters:

Naam Beschrijving Voorbeeld Vereist/optioneel
sensorId- Alleen apparaten retourneren die door een specifieke sensor worden gezien. Gebruik de id-waarde uit de resultaten van de sensoren (Sensoren ophalen) API. 1 Facultatief
notificationType- Bepaalt de typen apparaten die moeten worden geretourneerd. Ondersteunde waarden zijn onder andere:
- 0: zowel bijgewerkte als nieuwe apparaten (standaard).
- 1: alleen nieuwe apparaten.
- 2: alleen bijgewerkte apparaten.
2 Facultatief
pagina Hiermee definieert u het nummer waarop de paginanummering van het resultaat begint. 0= eerste pagina is bijvoorbeeld 0.
Standaard = 0
0 Facultatief
grootte Hiermee definieert u de grootte van de pagina. Standaard = 50 75 Facultatief

verbindingen (apparaatverbindingen ophalen)

Deze API retourneert gegevens over alle apparaatverbindingen die zijn bijgewerkt na de opgegeven tijdstempel.

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

URI-parameters:

Naam Beschrijving Voorbeeld Vereist/optioneel
tijdstempel De begintijd waaruit resultaten worden geretourneerd, in milliseconden van Epoch-tijd en in UTC-tijdzone. /external/v3/integration/devices/1664781014000 Vereist

TOEVOEGEN

queryparameters:

Naam Beschrijving Voorbeeld Vereist/optioneel
pagina Hiermee definieert u het nummer waarop de paginanummering van het resultaat begint. 0= eerste pagina is bijvoorbeeld 0.
Standaard = 0
0 Facultatief
grootte Hiermee definieert u de grootte van de pagina. Standaard = 50 75 Facultatief

apparaat (Details voor een apparaat ophalen)

Deze API retourneert gegevens over een specifiek apparaat per bepaalde apparaat-id.

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

TOEVOEGEN

queryparameters:

Naam Beschrijving Voorbeeld Vereist/optioneel
deviceId- De id van het aangevraagde apparaat op de on-premises beheerconsole 1 Vereist

deleteddevices (Verwijderde apparaten ophalen)

Deze API retourneert een lijst met id's van onlangs verwijderde apparaten, uit de opgegeven tijdstempel.

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

TOEVOEGEN

URI-parameters:

Naam Beschrijving Voorbeeld Vereist/optioneel
tijdstempel De begintijd waaruit resultaten worden geretourneerd, in milliseconden van Epoch-tijd en in UTC-tijdzone. /external/v3/integration/deleteddevices/1664781014000 Vereist

sensoren (Sensoren ophalen)

Deze API retourneert een lijst met sensorobjecten voor verbonden OT-netwerksensoren.

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

TOEVOEGEN

URI-: /sensors

Geen queryparameters

devicecves (APPARAAT-CV's ophalen)

Deze API retourneert een lijst met actieve CV's voor alle apparaten die zijn bijgewerkt sinds de opgegeven tijdstempel.

URI-: /external/v3/integration/devicecves/

TOEVOEGEN

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

URI-parameters

Naam Beschrijving Voorbeeld Vereist/optioneel
tijdstempel De begintijd waaruit resultaten worden geretourneerd, in milliseconden van Epoch-tijd en in UTC-tijdzone. /external/v3/integration/devicecves/1664781014000 Vereist

Queryparameters

Naam Beschrijving Voorbeeld Vereist/optioneel
pagina Hiermee definieert u het nummer waarop de paginanummering van het resultaat begint. 0= eerste pagina is 0.
Standaard = 0
Facultatief
grootte Hiermee definieert u de grootte van de pagina. Standaard = 50 Facultatief
sensorId- Toont resultaten van een specifieke sensor, zoals gedefinieerd door de opgegeven sensor-id. 1 Facultatief
score Bepaalt een minimale CVE-score die moet worden opgehaald. Alle resultaten hebben een CVE-score die gelijk is aan of groter is dan de opgegeven waarde. Standaard = 0. Facultatief
deviceIds Een door komma's gescheiden lijst met apparaat-id's waaruit u resultaten wilt weergeven. Bijvoorbeeld: 1232,34,2,456 Facultatief

Volgende stappen

Zie voor meer informatie: