Dela via


Referens för integrerings-API för lokala hanteringskonsoler (offentlig förhandsversion)

Den här artikeln innehåller de API:er som stöds för att integrera Microsoft Defender för IoT med partnertjänster.

Det här API:et implementeras till exempel för närvarande med Självstudie: Integrera ServiceNow med Microsoft Defender för IoT, via ServiceNow Service Graph Connector för Defender för IoT.

Anteckning

Integrerings-API:er är avsedda att köras kontinuerligt och skapa en dataström som körs hela tiden, till exempel för att fråga efter nya data från de senaste fem minuterna. Integrerings-API:er returnerar data med en tidsstämpel.

Om du bara vill fråga efter data använder du de vanliga API:erna som inte är integrerings-API:er i stället, antingen för en lokal hanteringskonsol för att fråga alla enheter eller för en specifik sensor för att fråga enheter från den sensorn. Mer information finns i Referens för Defender för IoT API.

URI: /external/v3/integration/

enheter (Skapa och uppdatera enheter)

Det här API:et returnerar data om alla enheter som uppdaterades efter den angivna tidsstämpeln.

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

URI-parametrar:

Name Beskrivning Exempel Obligatoriskt/valfritt
Tidsstämpel Starttiden från vilken resultaten returneras, i millisekunder från epoktiden och i UTC-tidszonen. /external/v3/integration/devices/1664781014000 Obligatorisk

GET

Frågeparametrar:

Name Beskrivning Exempel Obligatoriskt/valfritt
sensorId Returnera endast enheter som ses av en specifik sensor. Använd ID-värdet från resultatet av sensor-API:et (Get sensors). 1 Valfritt
notificationType Avgör vilka typer av enheter som ska returneras. Värden som stöds är:
- 0: Både uppdaterade och nya enheter (standard).
- 1: Endast nya enheter.
- 2: Endast uppdaterade enheter.
2 Valfritt
Sida Definierar numret där resultatsidans numrering börjar. Till exempel 0= första sidan är 0.
Standard = 0
0 Valfritt
Storlek Definierar sidstorleken. Standard = 50 75 Valfritt

anslutningar (Hämta enhetsanslutningar)

Det här API:et returnerar data om alla enhetsanslutningar som uppdaterades efter den angivna tidsstämpeln.

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

URI-parametrar:

Name Beskrivning Exempel Obligatoriskt/valfritt
Tidsstämpel Starttiden från vilken resultaten returneras, i millisekunder från epoktiden och i UTC-tidszonen. /external/v3/integration/devices/1664781014000 Obligatorisk

GET

Frågeparametrar:

Name Beskrivning Exempel Obligatoriskt/valfritt
Sida Definierar numret där resultatsidans numrering börjar. Till exempel 0= första sidan är 0.
Standard = 0
0 Valfritt
Storlek Definierar sidstorleken. Standard = 50 75 Valfritt

device (Hämta information för en enhet)

Det här API:et returnerar data om en specifik enhet per ett visst enhets-ID.

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

GET

Frågeparametrar:

Name Beskrivning Exempel Obligatoriskt/valfritt
Deviceid ID för den begärda enheten i den lokala hanteringskonsolen 1 Obligatorisk

deleteddevices (Hämta borttagna enheter)

Det här API:et returnerar en lista över ID:n för nyligen borttagna enheter från den angivna tidsstämpeln.

URI: /external/v3/integration/deleteddevices/

GET

URI-parametrar:

Name Beskrivning Exempel Obligatoriskt/valfritt
Tidsstämpel Starttiden från vilken resultaten returneras, i millisekunder från epoktiden och i UTC-tidszonen. /external/v3/integration/deleteddevices/1664781014000 Obligatorisk

sensorer (Hämta sensorer)

Det här API:et returnerar en lista över sensorobjekt för anslutna OT-nätverkssensorer.

URI: /external/v3/integration/sensors/

GET

URI: /sensors

Inga frågeparametrar

devicecves (Hämta enhets-CVEs)

Det här API:et returnerar en lista över aktiva CV:er för alla enheter som har uppdaterats sedan den angivna tidsstämpeln.

URI: /external/v3/integration/devicecves/

GET

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

URI-parametrar

Name Beskrivning Exempel Obligatoriskt/valfritt
Tidsstämpel Starttiden från vilken resultat returneras, i millisekunder från epoktid och i UTC-tidszon. /external/v3/integration/devicecves/1664781014000 Obligatorisk

Frågeparametrar

Name Beskrivning Exempel Obligatoriskt/valfritt
Sida Definierar talet där resultatsidans numrering börjar. 0= första sidan är 0.
Standard = 0
Valfritt
Storlek Definierar sidstorleken. Standard = 50 Valfritt
sensorId Visar resultat från en specifik sensor, enligt definitionen i det angivna sensor-ID:t. 1 Valfritt
Poäng Anger en lägsta CVE-poäng som ska hämtas. Alla resultat har en CVE-poäng som är lika med eller större än det angivna värdet. Standard = 0. Valfritt
deviceIds En kommaavgränsad lista över enhets-ID:n som du vill visa resultat från. Exempelvis: 1232,34,2,456 Valfritt

Nästa steg

Mer information finns i: