컴퓨터 오프보드 APIOffboard machine API

적용 대상:Applies to:

Endpoint용 Defender를 경험하고 싶나요?Want to experience Defender for Endpoint? 무료 평가판에 등록합니다.Sign up for a free trial.

참고

미국 정부 고객인 경우 미국 정부 고객용 끝점용 Microsoft Defender에나열된 URIS를 사용하시기 바랍니다.If you are a US Government customer, please use the URIs listed in Microsoft Defender for Endpoint for US Government customers.

성능을 향상하기 위해 지리적 위치에 더 가까운 서버를 사용할 수 있습니다.For better performance, you can use server closer to your geo location:

  • api-us.securitycenter.microsoft.comapi-us.securitycenter.microsoft.com
  • api-eu.securitycenter.microsoft.comapi-eu.securitycenter.microsoft.com
  • api-uk.securitycenter.microsoft.comapi-uk.securitycenter.microsoft.com

API 설명API description

Endpoint용 Defender에서 디바이스를 오프보드합니다.Offboard device from Defender for Endpoint.

제한 사항Limitations

  • 이 API에 대한 속도 제한은 분당 100통 및 시간당 1500통입니다.Rate limitations for this API are 100 calls per minute and 1500 calls per hour.

참고

이 페이지는 API를 통해 컴퓨터 작업을 수행하는 데 초점을 맞추고 있습니다.This page focuses on performing a machine action via API. Microsoft Defender for Endpoint를 통해 응답 작업 기능에 대한 자세한 내용은 컴퓨터의 응답 작업 수행을 참조하세요.See take response actions on a machine for more information about response actions functionality via Microsoft Defender for Endpoint.

참고

이 API는 Windows 10 버전 1703 이상 또는 Windows Server 2019 이상에서 지원됩니다.This API is supported on Windows 10, version 1703 and later, or Windows Server 2019 and later. 이 API는 MacOS 또는 Linux 장치에서 지원되지 않습니다.This API is not supported on MacOS or Linux devices.

사용 권한Permissions

이 API를 호출하려면 다음 권한 중 하나가 필요합니다.One of the following permissions is required to call this API. 사용 권한을 선택하는 방법을 포함하여 자세한 내용은 끝점 API에 Defender 사용을 참조합니다.To learn more, including how to choose permissions, see Use Defender for Endpoint APIs

사용 권한 유형Permission type 사용 권한Permission 사용 권한 표시 이름Permission display name
응용 프로그램Application Machine.OffboardMachine.Offboard '컴퓨터 오프보드''Offboard machine'
위임(직장 또는 학교 계정)Delegated (work or school account) Machine.OffboardMachine.Offboard '컴퓨터 오프보드''Offboard machine'

참고

사용자 자격 증명을 사용하여 토큰을 얻을 때:When obtaining a token using user credentials:

  • 사용자에게 '전역 관리자' AD 역할이 필요합니다.The user needs to 'Global Admin' AD role
  • 사용자는 장치 그룹 설정에 따라 장치에 액세스할 수 있습니다(자세한 내용은 장치 그룹 만들기 및 관리 참조).The user needs to have access to the device, based on device group settings (See Create and manage device groups for more information)

HTTP 요청HTTP request

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

요청 헤더Request headers

이름Name 유형Type 설명Description
권한 부여Authorization StringString Bearer {token}.Bearer {token}. 필수입니다.Required.
Content-TypeContent-Type 문자열string application/json.application/json. 필수입니다.Required.

요청 본문Request body

요청 본문에 다음 매개 변수를 사용하여 JSON 개체를 제공합니다.In the request body, supply a JSON object with the following parameters:

매개 변수Parameter 유형Type 설명Description
CommentComment StringString 작업과 연결되는 설명입니다.Comment to associate with the action. 필수입니다.Required.

응답Response

성공하면 이 메서드는 응답 본문에 201 - 생성된 응답 코드 및 컴퓨터 작업을 반환합니다.If successful, this method returns 201 - Created response code and Machine Action in the response body.

예시Example

요청Request

다음은 요청의 예입니다.Here is an example of the request.

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