Get machineAction API

Article
04/24/2024

Applies to:

Want to experience Microsoft Defender for Endpoint? Sign up for a free trial.

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

Retrieves specific Machine Action by its ID.

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 Use Defender for Endpoint APIs.

Permission type	Permission	Permission display name
Application	Machine.Read.All	'Read all machine profiles'
Application	Machine.ReadWrite.All	'Read and write all machine information'
Delegated (work or school account)	Machine.Read	'Read machine information'
Delegated (work or school account)	Machine.ReadWrite	'Read and write machine information'

Note

When obtaining a token using user credentials:

The user needs to have at least the following role permission: 'View Data' (For more information, see Create and manage roles)

HTTP request

GET https://api.securitycenter.microsoft.com/api/machineactions/{id}

Request headers

Name	Type	Description
Authorization	String	Bearer {token}. Required.

Request body

Empty

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

Example request

Here's an example of the request.

GET https://api.securitycenter.microsoft.com/api/machineactions/2e9da30d-27f6-4208-81f2-9cd3d67893ba

Response example

Here's an example of the response.

HTTP/1.1 200 Ok
Content-type: application/json
{
    "@odata.context": "https://api.securitycenter.microsoft.com/api/$metadata#MachineActions/$entity",
    "id": "5382f7ea-7557-4ab7-9782-d50480024a4e",
    "type": "Isolate",
    "scope": "Selective",
    "requestor": "Analyst@TestPrd.onmicrosoft.com",
    "requestorComment": "test for docs",
    "status": "Succeeded",
    "machineId": "7b1f4967d9728e5aa3c06a9e617a22a4a5a17378",
    "computerDnsName": "desktop-test",
    "creationDateTimeUtc": "2019-01-02T14:39:38.2262283Z",
    "lastUpdateDateTimeUtc": "2019-01-02T14:40:44.6596267Z",
    "relatedFileInfo": null
}

Tip

Do you want to learn more? Engage with the Microsoft Security community in our Tech Community: Microsoft Defender for Endpoint Tech Community.

Share via