واجهة برمجة تطبيقات الجهاز خارج اللوحة

وصف واجهة برمجة التطبيقات

جهاز إلغاء الإلحاق من Defender لنقطة النهاية.

المتطلبات الأساسية

أنظمة التشغيل المدعومة

نظام التشغيل الإصدارات المدعومة
عميل Windows Windows 11 و Windows 10، الإصدار 1703 وما بعده
Windows Server Windows Server 2019 وما بعده؛ Windows Server 2012 R2 و Windows Server 2016 عند استخدام الوكيل الموحد الجديد ل Defender for Endpoint
ماك أو إس macOS 14 وما بعده
Linux توزيعات Linux المدعومة

القيود

  • قيود المعدل لواجهة برمجة التطبيقات هذه هي 100 استدعاء في الدقيقة و1500 مكالمة في الساعة.
  • على أجهزة Windows، تشغيل واجهة برمجة تطبيقات الخروج يوقف خدمة المستشعر فقط. لا يزيل معلومات الانضمام من السجل كما يفعل سكربت التفريغ.

الأذونات

توصي Microsoft باستخدام الأدوار ذات الأذونات القليلة. يساعد ذلك في تحسين الأمان لمؤسستك. يعتبر المسؤول العام دورا متميزا للغاية يجب أن يقتصر على سيناريوهات الطوارئ عندما لا يمكنك استخدام دور موجود.

عند الحصول على رمز مميز باستخدام بيانات اعتماد المستخدم:

أحد الأذونات التالية مطلوب لاستدعاء واجهة برمجة التطبيقات هذه. لمعرفة المزيد، بما في ذلك كيفية اختيار الأذونات، راجع استخدام واجهات برمجة تطبيقات Defender لنقطة النهاية

نوع الإذن اذن اسم عرض الإذن
Application Machine.Offboard Offboard machine
مفوض (حساب العمل أو المؤسسة التعليمية) Machine.Offboard Offboard machine

طلب HTTP

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

يمكن العثور على معرف الجهاز في عنوان URL عند تحديد الجهاز. بشكل عام، إنه رقم أبجدي رقمي مكون من 40 رقما يمكن العثور عليه في عنوان URL.

عناوين الطلبات

الاسم النوع الوصف
التخويل سلسلة الحامل {token}. مطلوب.
نوع المحتوى سلسله application/json. مطلوب.

نص الطلب

في نص الطلب، قم بتوفير كائن JSON بالمعلمات التالية:

المعلمه النوع الوصف
التعليق سلسلة التعليق لإقرانه بالإجراء. مطلوب.

استجابه

إذا نجحت، يقوم هذا الأسلوب بإرجاع 200 - Created response التعليمات البرمجية وإجراء الجهاز في نص الاستجابة.

مثال

طلب

فيما يلي مثال على الطلب. إذا لم تتم إضافة تعليق JSON، فإنه يخطئ مع التعليمات البرمجية 400.

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