Dela via

Köra API för antivirusgenomsökning

  • Artikel

Gäller för:

Vill du uppleva Microsoft Defender för Endpoint? Registrera dig för en kostnadsfri utvärderingsversion.

Obs!

Om du är en us government-kund använder du de URI:er som anges i Microsoft Defender för Endpoint för amerikanska myndighetskunder.

Tips

För bättre prestanda kan du använda servern närmare din geoplats:

  • us.api.security.microsoft.com
  • eu.api.security.microsoft.com
  • uk.api.security.microsoft.com
  • au.api.security.microsoft.com
  • swa.api.security.microsoft.com
  • ina.api.security.microsoft.com

API-beskrivning

Initiera Microsoft Defender Antivirus-genomsökning på en enhet.

Begränsningar

  1. Hastighetsbegränsningar för det här API:et är 100 anrop per minut och 1 500 anrop per timme.

Obs!

Den här sidan fokuserar på att utföra en datoråtgärd via API. Mer information om svarsåtgärder via Microsoft Defender för Endpoint finns i Vidta svarsåtgärder på en dator .

Viktigt

  • Den här åtgärden är tillgänglig för enheter i Windows 10, version 1709 eller senare och i Windows 11.
  • En Microsoft Defender Antivirus-genomsökning kan köras tillsammans med andra antiviruslösningar, oavsett om Microsoft Defender Antivirus är den aktiva antiviruslösningen eller inte. Microsoft Defender Antivirus kan vara i passivt läge. Mer information finns i Microsoft Defender Antivirus-kompatibilitet.

Behörigheter

En av följande behörigheter krävs för att anropa det här API:et. Mer information, inklusive hur du väljer behörigheter, finns i Använda Api:er för Microsoft Defender för Endpoint

Behörighetstyp Behörighet Visningsnamn för behörighet
Program Machine.Scan "Genomsökningsmaskin"
Delegerat (arbets- eller skolkonto) Machine.Scan "Genomsökningsmaskin"

Obs!

När du hämtar en token med användarautentiseringsuppgifter:

  • Användaren måste ha minst följande rollbehörighet: "Aktiva reparationsåtgärder" (mer information finns i Skapa och hantera roller )
  • Användaren måste ha åtkomst till enheten baserat på enhetsgruppsinställningarna (mer information finns i Skapa och hantera enhetsgrupper )

Skapande av enhetsgrupp stöds i Defender för Endpoint Plan 1 och Plan 2.

HTTP-begäran

POST https://api.security.microsoft.com/api/machines/{id}/runAntiVirusScan

Frågerubriker

Namn Typ Beskrivning
Tillstånd Sträng Ägaren {token}. Krävs.
Content-Type sträng application/json

Frågebrödtext

I begärandetexten anger du ett JSON-objekt med följande parametrar:

Parameter Typ Beskrivning
Kommentar Sträng Kommentar som ska associeras med åtgärden. Krävs.
ScanType Sträng Definierar typen av genomsökning. Krävs.

ScanType styr vilken typ av genomsökning som ska utföras och kan vara något av följande:

  • Snabb: Utföra snabbgenomsökning på enheten
  • Fullständig: Utför fullständig genomsökning på enheten

Svar

Om det lyckas returnerar den här metoden 201, Skapad svarskod och MachineAction-objekt i svarstexten.

Om du skickar flera API-anrop för att köra en antivirussökning för samma enhet returneras "väntande datoråtgärd" eller HTTP 400 med meddelandet "Åtgärden pågår redan".

Exempel

Begäran

Här är ett exempel på begäran.

POST https://api.security.microsoft.com/api/machines/1e5bc9d7e413ddd7902c2932e418702b84d0cc07/runAntiVirusScan 

{
  "Comment": "Check machine for viruses due to alert 3212",
  "ScanType": "Full"
}

Tips

Vill du veta mer? Interagera med Microsoft Security-communityn i vår Tech Community: Microsoft Defender för Endpoint Tech Community.