Offboard-machine-API
Van toepassing op:
- Plan 1 voor Microsoft Defender voor Eindpunt
- Microsoft Defender voor Eindpunt
- Microsoft Defender XDR
Wilt u Defender voor Eindpunt ervaren? Meld u aan voor een gratis proefversie.
Opmerking
Als u een klant van de Amerikaanse overheid bent, gebruikt u de URI's die worden vermeld in Microsoft Defender voor Eindpunt voor klanten van de Amerikaanse overheid.
Tip
Voor betere prestaties kunt u de server dichter bij uw geografische locatie gebruiken:
- 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-beschrijving
Offboard-apparaat van Defender voor Eindpunt.
Beperkingen
Frequentiebeperkingen voor deze API zijn 100 aanroepen per minuut en 1500 aanroepen per uur.
Opmerking
Deze pagina is gericht op het uitvoeren van een machineactie via API. Zie Responsacties uitvoeren op een computer voor meer informatie over de functionaliteit van antwoordacties via Microsoft Defender voor Eindpunt.
Opmerking
- Deze API wordt ondersteund op Windows 11, Windows 10, versie 1703 en hoger, op Windows Server 2019 en hoger, en op Windows Server 2012 R2 en Windows Server 2016 wanneer u de nieuwe, geïntegreerde agent voor Defender voor Eindpunt gebruikt.
- Deze API wordt niet ondersteund op macOS- of Linux-apparaten.
- Het uitvoeren van de offboarding-API voorkomt alleen dat de sensorservice wordt uitgevoerd, maar de onboardinggegevens worden niet uit het register verwijderd, zoals bij een offboardingscript.
Machtigingen
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 |
Belangrijk
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 juiste rol zijn toegewezen (zie Machtigingsopties).
De gebruiker moet toegang hebben tot het apparaat, op basis van de instellingen van de apparaatgroep. Zie Apparaatgroepen maken en beheren voor meer informatie.
Het maken van een apparaatgroep wordt ondersteund in Defender for Endpoint Plan 1 en Plan 2.
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 |
|---|---|---|
| Machtiging | Tekenreeks | Bearer {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"
}
Tip
Wil je meer weten? Engage met de Microsoft Security-community in onze Tech Community: Microsoft Defender voor Eindpunt Tech Community.