Udostępnij za pośrednictwem

Interfejs API maszyny odłączaowej

  • Artykuł

Dotyczy:

Chcesz poznać usługę ochrony punktu końcowego w usłudze Microsoft Defender? Utwórz konto, aby skorzystać z bezpłatnej wersji próbnej.

Uwaga

Jeśli jesteś klientem rządowym USA, użyj identyfikatorów URI wymienionych w Ochrona punktu końcowego w usłudze Microsoft Defender dla klientów rządowych USA.

Porada

Aby uzyskać lepszą wydajność, możesz użyć serwera bliżej lokalizacji geograficznej:

  • 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

Opis interfejsu API

Odłącz urządzenie od usługi Defender for Endpoint.

Ograniczenia

  • Ograniczenia szybkości dla tego interfejsu API to 100 wywołań na minutę i 1500 wywołań na godzinę.

    Uwaga

    Ta strona koncentruje się na wykonywaniu akcji maszyny za pośrednictwem interfejsu API. Aby uzyskać więcej informacji na temat funkcji akcji reagowania za pośrednictwem Ochrona punktu końcowego w usłudze Microsoft Defender, zobacz akcje reagowania na maszynie.

Uwaga

  • Ten interfejs API jest obsługiwany w systemie Windows 11, Windows 10, wersji 1703 lub nowszej; w systemie Windows Server 2019 lub nowszym oraz w Windows Server 2012 R2 i Windows Server 2016 podczas korzystania z nowego, ujednoliconego agenta usługi Defender for Endpoint.
  • Ten interfejs API nie jest obsługiwany na urządzeniach z systemem macOS lub Linux.
  • Uruchomienie interfejsu API odłączania tylko uniemożliwia działanie usługi czujnika, ale nie usuwa informacji dołączania z rejestru, tak jak w przypadku skryptu odłączania.

Uprawnienia

Do wywołania tego interfejsu API jest wymagane jedno z następujących uprawnień. Aby dowiedzieć się więcej, w tym jak wybrać uprawnienia, zobacz Korzystanie z usługi Defender dla interfejsów API punktu końcowego

Typ uprawnień Uprawnienie Nazwa wyświetlana uprawnień
Aplikacja Machine.Offboard "Maszyna odłączona"
Delegowane (konto służbowe) Machine.Offboard "Maszyna odłączona"

Uwaga

Podczas uzyskiwania tokenu przy użyciu poświadczeń użytkownika:

  • Użytkownik musi mieć rolę usługi AD "Global Administracja"
  • Użytkownik musi mieć dostęp do urządzenia na podstawie ustawień grupy urządzeń (zobacz Twórca i zarządzanie grupami urządzeń, aby uzyskać więcej informacji)

Tworzenie grupy urządzeń jest obsługiwane w usłudze Defender for Endpoint Plan 1 i Plan 2.

Żądanie HTTP

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

Identyfikator komputera można znaleźć w adresie URL po wybraniu urządzenia. Ogólnie rzecz biorąc, jest to 40-cyfrowy numer alfanumeryczny, który można znaleźć w adresie URL.

Nagłówki żądań

Name (Nazwa) Wpisać Opis
Autoryzacji Ciąg Element nośny {token}. Wymagane.
Typ zawartości Ciąg application/json. Wymagane.

Treść żądania

W treści żądania podaj obiekt JSON z następującymi parametrami:

Parametr Wpisać Opis
Komentowanie Ciąg Komentarz do skojarzenia z akcją. Wymagane.

Odpowiedzi

W przypadku powodzenia ta metoda zwraca wartość 200 — utworzony kod odpowiedzi i akcję maszyny w treści odpowiedzi.

Przykład

Żądanie

Oto przykład żądania. Jeśli nie dodano komentarza JSON, zostanie wyświetlony błąd z kodem 400.

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

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

Porada

Chcesz dowiedzieć się więcej? Engage ze społecznością microsoft security w naszej społeczności technicznej: Ochrona punktu końcowego w usłudze Microsoft Defender Tech Community.