mirror of
https://github.com/MicrosoftDocs/windows-itpro-docs.git
synced 2025-06-23 06:13:41 +00:00
103 lines
3.1 KiB
Markdown
103 lines
3.1 KiB
Markdown
---
|
|
title: Get MachineAction object API
|
|
description: Use this API to create calls related to get machineaction object
|
|
keywords: apis, graph api, supported apis, machineaction object
|
|
search.product: eADQiWindows 10XVcnh
|
|
ms.prod: w10
|
|
ms.mktglfcycl: deploy
|
|
ms.sitesec: library
|
|
ms.pagetype: security
|
|
ms.author: macapara
|
|
author: mjcaparas
|
|
ms.localizationpriority: medium
|
|
manager: dansimp
|
|
audience: ITPro
|
|
ms.collection: M365-security-compliance
|
|
ms.topic: article
|
|
---
|
|
|
|
# Get machineAction API
|
|
|
|
**Applies to:** [Microsoft Defender Advanced Threat Protection (Microsoft Defender ATP)](https://go.microsoft.com/fwlink/p/?linkid=2069559)
|
|
|
|
- Want to experience Microsoft Defender ATP? [Sign up for a free trial.](https://www.microsoft.com/microsoft-365/windows/microsoft-defender-atp?ocid=docs-wdatp-exposedapis-abovefoldlink)
|
|
|
|
|
|
## API description
|
|
Retrieves specific [Machine Action](machineaction.md) by its ID.
|
|
|
|
|
|
## Limitations
|
|
1. 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 Microsoft Defender ATP APIs](apis-intro.md)
|
|
|
|
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' (See [Create and manage roles](user-roles.md) for more information)
|
|
|
|
## HTTP request
|
|
```
|
|
GET https://api.securitycenter.windows.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](machineaction.md) entity. If machine action entity with the specified id was not found - 404 Not Found.
|
|
|
|
## Example
|
|
|
|
**Request**
|
|
|
|
Here is an example of the request.
|
|
|
|
[!include[Improve request performance](../../includes/improve-request-performance.md)]
|
|
|
|
```
|
|
GET https://api.securitycenter.windows.com/api/machineactions/2e9da30d-27f6-4208-81f2-9cd3d67893ba
|
|
```
|
|
|
|
**Response**
|
|
|
|
Here is an example of the response.
|
|
|
|
|
|
```
|
|
HTTP/1.1 200 Ok
|
|
Content-type: application/json
|
|
{
|
|
"@odata.context": "https://api.securitycenter.windows.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
|
|
}
|
|
|
|
|
|
```
|