Isolate machine API

Applies to: Microsoft Defender Advanced Threat Protection (Microsoft Defender ATP)

API description

Isolates a device from accessing external network.

Limitations

  1. Rate limitations for this API are 100 calls per minute and 1500 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 ATP.

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.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' (See Create and manage roles for more information)
  • The user needs to have access to the device, based on device group settings (See Create and manage device groups for more information)

HTTP request

POST https://api.securitycenter.windows.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' or 'Selective'.

IsolationType controls the type of isolation to perform and can be one of the following:

  • Full – Full isolation
  • Selective – Restrict only limited set of applications from accessing the network (see Isolate devices from the network for more details)

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.

Note

For better performance, you can use server closer to your geo location:

  • api-us.securitycenter.microsoft.com
  • api-eu.securitycenter.microsoft.com
  • api-uk.securitycenter.microsoft.com
POST https://api.securitycenter.windows.com/api/machines/1e5bc9d7e413ddd7902c2932e418702b84d0cc07/isolate
Content-type: application/json
{
  "Comment": "Isolate machine due to alert 1234",
  “IsolationType”: “Full” 
}


- To unisolate a device, see [Release device from isolation](unisolate-machine.md).