Referens för Defender för IoT API

Artikel
12/18/2023

I det här avsnittet beskrivs de offentliga API:er som stöds av Microsoft Defender för IoT. Defender for IoT-API:er styrs av Licens och användningsvillkor för Microsoft API.

Använd Defender för IoT-API:er för att komma åt data som identifieras av sensorer och lokala hanteringskonsoler och utföra åtgärder med dessa data.

API-anslutningar skyddas via SSL.

Generera en API-åtkomsttoken

Många Defender för IoT-API:er kräver en åtkomsttoken. Åtkomsttoken krävs inte för autentiserings-API:er.

Så här genererar du en token:

I fönstret System Inställningar väljer du Åtkomsttoken för integreringar>.
Välj Generera token.
I Beskrivning beskriver du vad den nya token är till för och väljer Generera.
Åtkomsttoken visas. Kopiera den eftersom den inte visas igen.
Välj Slutför.
- De token som du skapar visas i dialogrutan Åtkomsttoken . Använd anger den senaste gången ett externt anrop med den här token togs emot.
- N/A i fältet Används anger att anslutningen mellan sensorn och den anslutna servern inte fungerar.

När du har genererat token lägger du till ett HTTP-huvud med rubriken Auktorisering i din begäran och anger dess värde till den token som du genererade.

Referens för sensor-API-version

Version	API:er som stöds
Ingen version	Autentisering och lösenordshantering: - set_password (Ändra ditt lösenord) - set_password_by_admin (Uppdatera ett användarlösenord av administratör) - validering (Verifiera användarautentiseringsuppgifter)
Ny i version 1	Inventering: - anslutningar (Hämta information om enhetsanslutning) - cves (Hämta information om CVE:er) - enheter (Hämta enhetsinformation) Aviseringar: - aviseringar (Hämta aviseringsinformation) - händelser (Hämta tidslinjehändelser) Sårbarheter: - drift (Hämta sårbarheter i drift) - enheter (Hämta information om enhetens säkerhetsrisker) - mitigation (Hämta åtgärdssteg) - säkerhet (Hämta säkerhetsrisker)
Nytt i version 2	Aviseringar: – Uppdateringar till aviseringar (Hämta aviseringsinformation)

Api-versionsreferens för den lokala hanteringskonsolen

Version	API:er
Ingen version	Autentisering och lösenordshantering: - set_password (Ändra lösenord) - set_password_by_admin (Uppdatering av användarlösenord av systemadministratör) - validering (autentisera användarautentiseringsuppgifter)
Ny i version 1	Platser - apparater (Hantera OT-sensorapparater) Inventering: - enheter (Hämta all enhetsinformation) Aviseringar: - aviseringar (Hämta aviseringsinformation) - maintenanceWindow (Skapa aviseringsundantag)
Nytt i version 2	Aviseringar: – Uppdateringar till aviseringar (Hämta aviseringsinformation) - pcap (PCAP för begärandeavisering)
Nytt i version 3	Integrerings-API:er: - anslutningar (Hämta enhetsanslutningar) - enhet (Hämta information för en enhet) - devicecves (Hämta enhets-CVE:er) - enheter (Skapa och uppdatera enheter) - deleteddevices (Hämta borttagna enheter) - sensorer (Hämta sensorer)

Kommentar

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.

Epoktid

I alla Tidsstämpelvärden för Defender för IoT är epoktiden lika med 1/1/1970.

Nästa steg

Mer information finns i:

Dela via