windows-itpro-docs/windows/security/threat-protection/microsoft-defender-atp/offboard-machine-api.md

title, description, keywords, search.product, ms.prod, ms.mktglfcycl, ms.sitesec, ms.pagetype, ms.author, author, ms.localizationpriority, manager, audience, ms.collection, ms.topic

title	description	keywords	search.product	ms.prod	ms.mktglfcycl	ms.sitesec	ms.pagetype	ms.author	author	ms.localizationpriority	manager	audience	ms.collection	ms.topic
Offboard machine API	Use this API to offboard a machine from WDATP.	apis, graph api, supported apis, collect investigation package	eADQiWindows 10XVcnh	w10	deploy	library	security	macapara	mjcaparas	medium	dansimp	ITPro	M365-security-compliance	article

Offboard machine API

Applies to:

• Microsoft Defender Advanced Threat Protection (Microsoft Defender ATP)

Offboard machine from Microsoft Defender ATP.

[!includeMachine actions note]

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Use Microsoft Defender ATP APIs

Permission type	Permission	Permission display name
Application	Machine.Offboard	'Offboard machine'
Delegated (work or school account)	Machine.Offboard	'Offboard machine'

Note

When obtaining a token using user credentials:

• The user needs to 'Global Admin' AD role
• The user needs to have access to the machine, based on machine group settings (See Create and manage machine groups for more information)

HTTP request

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

Request headers

Name	Type	Description
Authorization	String	Bearer {token}. Required.
Content-Type	string	application/json. Required.

Request body

In the request body, supply a JSON object with the following parameters:

Parameter	Type	Description
Comment	String	Comment to associate with the action. Required.

Response

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.

[!includeImprove request performance]

POST https://api.securitycenter.windows.com/api/machines/1e5bc9d7e413ddd7902c2932e418702b84d0cc07/offboard
Content-type: application/json
{
  "Comment": "Offboard machine by automation"
}

Response

Here is an example of the response.

HTTP/1.1 201 Created
Content-type: application/json
{
    "@odata.context": "https://api.securitycenter.windows.com/api/$metadata#MachineActions/$entity",
    "id": "c9042f9b-8483-4526-87b5-35e4c2532223",
    "type": "OffboardMachine",
    "requestor": "Analyst@contoso.com",
    "requestorComment": "offboard machine by automation",
    "status": "InProgress",
    "machineId": "1e5bc9d7e413ddd7902c2932e418702b84d0cc07",
    "creationDateTimeUtc": "2018-12-04T12:09:24.1785079Z",
    "lastUpdateTimeUtc": "2018-12-04T12:09:24.1785079Z",
	"relatedFileInfo": null
}