Offboard-machine-API

API-beschrijving

Offboard-apparaat van Defender voor Eindpunt.

Vereisten

Ondersteunde besturingssystemen

besturingssysteem	Ondersteunde versies
Windows-client	Windows 11 en Windows 10, versie 1703 en later
Windows Server	Windows Server 2019 en later; Windows Server 2012 R2 en Windows Server 2016 wanneer de nieuwe, geünificeerde agent voor Defender for Endpoint wordt gebruikt
macOS	macOS 14 en later
Linux	Ondersteunde Linux-distributies

Beperkingen

• Frequentiebeperkingen voor deze API zijn 100 aanroepen per minuut en 1500 aanroepen per uur.
• Op Windows-apparaten stopt het uitvoeren van de offboarding API alleen de sensorservice. Het verwijdert de onboardinginformatie niet uit het register zoals een offboardingscript dat doet.

Machtigingen

Microsoft raadt u aan rollen te gebruiken met de minste machtigingen. Dit helpt bij het verbeteren van de beveiliging voor uw organisatie. Globale beheerder is een zeer bevoorrechte rol die moet worden beperkt tot scenario's voor noodgevallen wanneer u een bestaande rol niet kunt gebruiken.

Bij het verkrijgen van een token met behulp van gebruikersreferenties:

• Aan de gebruiker moet een geschikte rol zijn toegewezen. Zie Machtigingsopties voor meer informatie.

• De gebruiker moet toegang hebben tot het apparaat, op basis van de instellingen van de apparaatgroep. Zie Apparaatgroepen maken en beheren voor meer informatie.

Een van de volgende machtigingen is vereist om deze API aan te roepen. Zie Defender voor Eindpunt-API's gebruiken voor meer informatie, waaronder het kiezen van machtigingen.

Machtigingstype	Machtiging	Weergavenaam van machtiging
Toepassing	Machine.Offboard	Offboard machine
Gedelegeerd (werk- of schoolaccount)	Machine.Offboard	Offboard machine

HTTP-aanvraag

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

De machine-id vindt u in de URL wanneer u het apparaat selecteert. Over het algemeen is dit een alfanumerieke waarde van 40 cijfers die in de URL te vinden is.

Aanvraagheaders

Naam	Type	Beschrijving
Vergunning	Tekenreeks	Drager {token}. Vereist.
Content-Type	tekenreeks	application/json. Vereist.

Aanvraagtekst

Geef in de aanvraagtekst een JSON-object op met de volgende parameters:

Parameter	Type	Beschrijving
Opmerking	Tekenreeks	Opmerking om aan de actie te koppelen. Vereist.

Antwoord

Als dit lukt, retourneert 200 - Created response deze methode code en machineactie in de hoofdtekst van het antwoord.

Voorbeeld

Verzoek

Hier volgt een voorbeeld van de aanvraag. Als er geen JSON-opmerking is toegevoegd, worden er fouten weergegeven met code 400.

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

{
  "Comment": "Offboard machine by automation"
}