API:t för att stoppa och sätta i karantänStop and quarantine file API

Gäller för: Microsoft Defender för slutpunktApplies to: Microsoft Defender for Endpoint

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.If you are a US Government customer, please use the URIs listed in Microsoft Defender for Endpoint for US Government customers.

Tips

För bättre prestanda kan du använda servern närmare din geografiska plats:For better performance, you can use server closer to your geo location:

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

API-beskrivningAPI description

Sluta utföra en fil på en enhet och ta bort den.Stop execution of a file on a device and delete it.

BegränsningarLimitations

  1. Prisbegränsningar för detta API är 100 samtal per minut och 1 500 samtal per timme.Rate limitations for this API are 100 calls per minute and 1500 calls per hour.

Anteckning

Den här sidan fokuserar på att utföra maskinåtgärder via API.This page focuses on performing a machine action 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.See take response actions on a machine for more information about response actions functionality via Microsoft Defender for Endpoint.

BehörigheterPermissions

En av följande behörigheter krävs för att anropa detta API.One of the following permissions is required to call this API. Mer information, inklusive hur du väljer behörigheter, finns i Använda Microsoft Defender för slutpunkts-API:erTo learn more, including how to choose permissions, see Use Microsoft Defender for Endpoint APIs

BehörighetstypPermission type BehörighetPermission Visningsnamn för behörighetPermission display name
ProgramApplication Machine.StopAndQuarantineMachine.StopAndQuarantine Stoppa och sätta i karantän'Stop And Quarantine'
Delegerat (arbets- eller skolkonto)Delegated (work or school account) Machine.StopAndQuarantineMachine.StopAndQuarantine Stoppa och sätta i karantän'Stop And Quarantine'

Anteckning

När du skaffar en token med hjälp av användarautentiseringsuppgifter:When obtaining a token using user credentials:

  • Användaren måste ha minst följande rollbehörighet: 'Aktiva åtgärdsåtgärder'. (Mer information finns i Skapa och hantera roller)The user needs to have at least the following role permission: 'Active remediation actions' (See Create and manage roles for more information)
  • Användaren måste ha åtkomst till enheten baserat på enhetsgruppinställningar (mer information finns i Skapa och hantera enhetsgrupper)The user needs to have access to the device, based on device group settings (See Create and manage device groups for more information)

HTTP-begäranHTTP request

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

Begäran om rubrikerRequest headers

NamnName SkrivType BeskrivningDescription
AuktoriseringAuthorization SträngString Bearer {token}.Bearer {token}. Obligatoriskt.Required.
InnehållstypContent-Type strängstring application/json.application/json. Obligatoriskt.Required.

Begärans brödtextRequest body

Ange följande parametrar för ett JSON-objekt i begärans brödtext:In the request body, supply a JSON object with the following parameters:

ParameterParameter SkrivType BeskrivningDescription
KommentarComment SträngString Kommentar som ska associeras med åtgärden.Comment to associate with the action. Obligatoriskt.Required.
Sha1Sha1 SträngString Skuggning1 av filen för att stoppa och sätta i karantän på enheten.Sha1 of the file to stop and quarantine on the device. Obligatoriskt.Required.

SvarResponse

Om det lyckas returnerar den här metoden 201 – Skapad svarskod och Maskinåtgärd i svarstexten.If successful, this method returns 201 - Created response code and Machine Action in the response body.

ExempelExample

BegäranRequest

Här är ett exempel på begäran.Here is an example of the request.

POST https://api.securitycenter.microsoft.com/api/machines/1e5bc9d7e413ddd7902c2932e418702b84d0cc07/StopAndQuarantineFile 
{
  "Comment": "Stop and quarantine file on machine due to alert 441688558380765161_2136280442",
  "Sha1": "87662bc3d60e4200ceaf7aae249d1c343f4b83c9"
}