Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Important
Some information in this article relates to a prereleased product which may be substantially modified before it's commercially released. Microsoft makes no warranties, expressed or implied, with respect to the information provided here.
API description
Cancel an already launched machine action that isn't yet in final state (completed, canceled, failed).
Limitations
Rate limitations for this API are 100 calls per minute and 1500 calls per hour.
Permissions
One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Get started.
| Permission type | Permission | Permission display name |
|---|---|---|
| Application | Machine.CollectForensics Machine.Isolate Machine.RestrictExecution Machine.Scan Machine.Offboard Machine.StopAndQuarantine Machine.LiveResponse |
Collect forensics Isolate machine Restrict code execution Scan machine Offboard machine Stop And Quarantine Run live response on a specific machine |
| Delegated (work or school account) | Machine.CollectForensics Machine.Isolate Machine.RestrictExecution Machine.Scan Machine.Offboard Machine.StopAndQuarantineMachine.LiveResponse |
Collect forensics Isolate machine Restrict code execution Scan machine Offboard machine Stop And Quarantine Run live response on a specific machine |
HTTP request
POST https://api.security.microsoft.com/api/machineactions/<machineactionid>/cancel
Request headers
| Name | Type | Description |
|---|---|---|
| Authorization | String | Bearer {token}. Required. |
| Content-Type | string | application/json. Required. |
Request body
| Parameter | Type | Description |
|---|---|---|
| Comment | String | Comment to associate with the cancellation action. |
Response
If successful, this method returns 200, OK response code with a Machine Action entity. If machine action entity with the specified id wasn't found - 404 Not Found.
Example
Request
Here's an example of the request.
POST
https://api.security.microsoft.com/api/machineactions/aaaabbbb-0000-cccc-1111-dddd2222eeee/cancel
{
"Comment": "Machine action was canceled by automation"
}