API för avregistreringsdator

API-beskrivning

Avregistrera enheten från Defender för Endpoint.

Förhandskrav

Operativsystem som stöds

Operativsystem Versioner som stöds
Windows-klient Windows 11 och Windows 10, version 1703 och senare
Windows Server Windows Server 2019 och senare; Windows Server 2012 R2 och Windows Server 2016 när man använder den nya, enhetliga agenten för Defender for Endpoint
macOS macOS 14 och senare
Linux Linux distributioner som stöds

Begränsningar

  • Frekvensbegränsningar för det här API:et är 100 anrop per minut och 1 500 anrop per timme.
  • På Windows-enheter stoppar man bara sensortjänsten när man kör offboarding-API:et. Den tar inte bort onboarding-informationen från registret som ett offboarding-skript gör.

Behörigheter

Microsoft rekommenderar att du använder roller med minst behörighet. Detta bidrar till att förbättra säkerheten för din organisation. Global administratör är en mycket privilegierad roll som bör begränsas till nödsituationsscenarier när du inte kan använda en befintlig roll.

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

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 Defender för Endpoint-API:er

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

HTTP-begäran

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

Du hittar dator-ID:t i URL:en när du väljer enheten. I allmänhet är det ett 40-siffrigt alfanumeriskt tal som finns i URL:en.

Frågerubriker

Namn Typ Beskrivning
Behörighet Sträng Ägaren {token}. Krävs.
Content-Type sträng application/json. Krävs.

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.

Svar

Om det lyckas returnerar 200 - Created response den här metoden kod och maskinåtgärd i svarstexten.

Exempel

Begäran

Här är ett exempel på begäran. Om det inte finns någon JSON-kommentar tillagd fel med koden 400.

POST https://api.security.microsoft.com/api/machines/1e5bc9d7e413ddd7902c2932e418702b84d0cc07/offboard
{
  "Comment": "Offboard machine by automation"
}