Api för Offboard-dator
Gäller för:
- Microsoft Defender för Endpoint Abonnemang 1
- Microsoft Defender för Endpoint Abonnemang 2
- Microsoft 365 Defender
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
Offboard-enhet från Defender för Slutpunkt.
Begränsningar
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.
Anteckning
Detta API stöds i Windows 11, Windows 10, version 1703 och senare eller i Windows Server 2019 och senare.
Detta API stöds inte på MacOS- eller Linux-enheter.
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 Defender för slutpunkts-API:er
| Behörighetstyp | Behörighet | Visningsnamn för behörighet |
|---|---|---|
| Program | Machine.Offboard | 'Offboard machine' |
| Delegerat (arbets- eller skolkonto) | Machine.Offboard | 'Offboard machine' |
Anteckning
När du skaffar en token med hjälp av användarautentiseringsuppgifter:
- Användaren måste ha AD-roll som global administratör
- 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}/offboard
Maskin-ID:t hittar du i URL-adressen när du markerar enheten. I allmänhet är det ett 40-siffrigt alfanumeriskt tal som finns i URL-adressen.
Frågerubriker
| Namn | Typ | Beskrivning |
|---|---|---|
| Auktorisering | Sträng | Bearer {token}. Obligatoriskt. |
| Content-Type | sträng | application/json. Obligatoriskt. |
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. |
Svar
Om det lyckas returnerar den här metoden 201 – Skapad svarskod och Maskinåtgärd i svarstexten.
Exempel
Begäran
Här är ett exempel på begäran.
POST https://api.securitycenter.microsoft.com/api/machines/1e5bc9d7e413ddd7902c2932e418702b84d0cc07/offboard
{
"Comment": "Offboard machine by automation"
}