Kör API för antivirusskanning

Gäller för:

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

Anteckning

Om du är myndighetskund i USA kan du använda de URI:er som visas i Microsoft Defender för Slutpunkt för kunder inom myndigheter i USA.

Tips

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

  • api-us.securitycenter.microsoft.com
  • api-eu.securitycenter.microsoft.com
  • api-uk.securitycenter.microsoft.com

API-beskrivning

Starta Microsoft Defender Antivirus sökning på en enhet.

Begränsningar

  1. Prisbegränsningar för detta API är 100 samtal per minut och 1 500 samtal per timme.

Anteckning

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

Viktigt

  • Den här åtgärden är tillgänglig för enheter Windows 10, version 1709 eller senare och på Windows 11.
  • En Microsoft Defender Antivirus (Microsoft Defender AV) kan köras tillsammans med andra antivirusprogram, oavsett Microsoft Defender Antivirus är den aktiva antiviruslösningen eller inte. Microsoft Defender Antivirus 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 detta API. Mer information, inklusive hur du väljer behörigheter, finns i Använda Microsoft Defender för slutpunkts-API:er

Behörighetstyp Behörighet Visningsnamn för behörighet
Program Machine.Scan 'Scan machine'
Delegerat (arbets- eller skolkonto) Machine.Scan 'Scan machine'

Anteckning

När du skaffar en token med hjälp av användarautentiseringsuppgifter:

  • Användaren måste ha minst följande rollbehörighet: 'Aktiva åtgärdsåtgärder'. (Mer information finns i Skapa och hantera roller)
  • Användaren måste ha åtkomst till enheten baserat på enhetsgruppinställningar (mer information finns i Skapa och hantera enhetsgrupper)

HTTP-begäran

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

Frågerubriker

Namn Typ Beskrivning
Auktorisering Sträng Bearer {token}. Obligatoriskt.
Content-Type sträng application/json

Frågebrödtext

Ange följande parametrar för ett JSON-objekt i begärans brödtext:

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

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

  • Snabb: Genomför snabbsökning på enheten
  • Fullständig: Utför fullständig sökning på enheten

Svar

Om det lyckas returnerar den här metoden 201, Skapad svarskod och MachineAction-objekt i svarets brödtext.

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

Exempel

Begäran

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

POST https://api.securitycenter.microsoft.com/api/machines/1e5bc9d7e413ddd7902c2932e418702b84d0cc07/runAntiVirusScan 
{
  "Comment": "Check machine for viruses due to alert 3212",
  "ScanType": "Full"
}