Dela via


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

I den här artikeln visas de API:er som stöds för integrering av 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.

Not

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 vanliga API:er 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 att en specifik sensor endast ska fråga enheter från den sensorn. Mer information finns i Defender for IoT API-referens.

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:

Namn Beskrivning Exempel Obligatoriskt/valfritt
tidsstämpel Starttiden från vilken resultaten returneras, i millisekunder från epoktid och i UTC-tidszon. /external/v3/integration/devices/1664781014000 Krävs

Frågeparametrar:

Namn Beskrivning Exempel Obligatoriskt/valfritt
sensorId Returnera endast enheter som ses av en specifik sensor. Använd ID-värdet från resultatet av sensorer (Hämta sensorer) API. 1 Valfri
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 Valfri
sida Definierar talet där resultatsidans numrering börjar. Till exempel är 0= första sidan 0.
Standard = 0
0 Valfri
storlek Definierar sidstorleken. Standard = 50 75 Valfri

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:

Namn Beskrivning Exempel Obligatoriskt/valfritt
tidsstämpel Starttiden från vilken resultaten returneras, i millisekunder från epoktid och i UTC-tidszon. /external/v3/integration/devices/1664781014000 Krävs

Frågeparametrar:

Namn Beskrivning Exempel Obligatoriskt/valfritt
sida Definierar talet där resultatsidans numrering börjar. Till exempel är 0= första sidan 0.
Standard = 0
0 Valfri
storlek Definierar sidstorleken. Standard = 50 75 Valfri

enhet (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}

Frågeparametrar:

Namn Beskrivning Exempel Obligatoriskt/valfritt
deviceId ID för den begärda enheten i den lokala hanteringskonsolen 1 Krävs

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/

URI-parametrar:

Namn Beskrivning Exempel Obligatoriskt/valfritt
tidsstämpel Starttiden från vilken resultaten returneras, i millisekunder från epoktid och i UTC-tidszon. /external/v3/integration/deleteddevices/1664781014000 Krävs

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/

URI: /sensors

Inga frågeparametrar

devicecves (Hämta enhets-CVE:er)

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

URI: /external/v3/integration/devicecves/

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

URI-parametrar

Namn Beskrivning Exempel Obligatoriskt/valfritt
tidsstämpel Starttiden från vilken resultaten returneras, i millisekunder från epoktid och i UTC-tidszon. /external/v3/integration/devicecves/1664781014000 Krävs

Frågeparametrar

Namn Beskrivning Exempel Obligatoriskt/valfritt
sida Definierar talet där resultatsidans numrering börjar. 0= första sidan är 0.
Standard = 0
Valfri
storlek Definierar sidstorleken. Standard = 50 Valfri
sensorId Visar resultat från en specifik sensor enligt definitionen i det angivna sensor-ID:t. 1 Valfri
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. Valfri
deviceIds En kommaavgränsad lista över enhets-ID:n som du vill visa resultat från. Till exempel: 1232,34,2,456 Valfri

Nästa steg

Mer information finns i: