Isolate machine API
Applies to:
- Microsoft Defender for Endpoint Plan 1 or Plan 2
- Microsoft Defender XDR
- Microsoft Defender for Business
Note
If you are a US Government customer, please use the URIs listed in Microsoft Defender for Endpoint for US Government customers.
Tip
For better performance, you can use server closer to your geo location:
- 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
- ina.api.security.microsoft.com
API description
Isolates a device from accessing external network.
Limitations
- Rate limitations for this API are 100 calls per minute and 1,500 calls per hour.
Note
This page focuses on performing a machine action via API. See take response actions on a machine for more information about response actions functionality via Microsoft Defender for Endpoint.
Important
- Full isolation is available for devices on Windows 10, version 1703, and on Windows 11.
- Full isolation is available for all supported Linux devices. See Microsoft Defender for Endpoint on Linux.
- Selective isolation is available for devices on Windows 10, version 1709 or later, and on Windows 11.
- When isolating a device, only certain processes and destinations are allowed. Therefore, devices that are behind a full VPN tunnel won't be able to reach the Microsoft Defender for Endpoint cloud service after the device is isolated. We recommend using a split-tunneling VPN for Microsoft Defender for Endpoint and Microsoft Defender Antivirus cloud-based protection-related traffic.
- Calling this API on unmanaged devices triggers the contain device from the network action. The IsolationType value should be set to 'UnManagedDevice.'
Permissions
One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Use Microsoft Defender for Endpoint APIs
| Permission type | Permission | Permission display name |
|---|---|---|
| Application | Machine.Isolate | 'Isolate machine' |
| Delegated (work or school account) | Machine.Isolate | 'Isolate machine' |
Note
When obtaining a token using user credentials:
- The user needs to have at least the following role permission: 'Active remediation actions.' For more information, see Create and manage roles.
- The user needs to have access to the device, based on device group settings. See Create and manage device groups for more information.
Device group creation is supported in Defender for Endpoint Plan 1 and Plan 2.
HTTP request
POST https://api.securitycenter.microsoft.com/api/machines/{id}/isolate
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. |
| IsolationType | String | Type of the isolation. Allowed values are: Full, Selective, or UnManagedDevice. |
IsolationType controls the type of isolation to perform and can be one of the following:
- Full: Full isolation. Works for managed devices.
- Selective: Restrict only limited set of applications from accessing the network on managed devices. For more information, see Isolate devices from the network.
- UnManagedDevice: The isolation targets unmanaged devices only.
Response
If successful, this method returns 201 - Created response code and Machine Action in the response body.
Example
Request
Here's an example of the request.
POST https://api.securitycenter.microsoft.com/api/machines/1e5bc9d7e413ddd7902c2932e418702b84d0cc07/isolate
{
"Comment": "Isolate machine due to alert 1234",
"IsolationType": "Full"
}
- To release a device from isolation, see Release device from isolation.
Tip
Do you want to learn more? Engage with the Microsoft Security community in our Tech Community: Microsoft Defender for Endpoint Tech Community.