Edit

Update machine

  • Article

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

API description

Updates properties of existing Machine.

Updatable properties are: machineTags and deviceValue.

Limitations

  1. You can update machines that are available in the API.
  2. Update machine only appends tags to the tag collection. If tags exist, they must be included in the tags collection in the body.
  3. 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 for Endpoint APIs

Permission type Permission Permission display name
Application Machine.ReadWrite.All 'Read and write machine information for all machines'
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: 'Alerts investigation'. For more information, see Create and manage roles.
  • The user needs to have access to the device associated with the alert, based on device group settings. For more information, see Create and manage device groups.

Device group creation is supported in Defender for Endpoint Plan 1 and Plan 2.

HTTP request

PATCH /api/machines/{machineId}

Request headers

Name Type Description
Authorization String Bearer {token}. Required.
Content-Type String application/json. Required.

Request body

In the request body, supply the values for the relevant fields that should be updated.

Existing properties that aren't included in the request body will maintain their previous values or be recalculated based on changes to other property values.

For best performance, you shouldn't include existing values that haven't change.

Property Type Description
machineTags String collection Set of machine tags.
deviceValue Nullable Enum The value of the device. Possible values are: 'Normal', 'Low' and 'High'.

Response

If successful, this method returns 200 OK, and the machine entity in the response body with the updated properties.

If machine tags collection in body doesn't contain existing machine tags - replaces all tags with the tags provided in the request body.

If machine with the specified ID wasn't found - 404 Not Found.

Example

Request

Here's an example of the request.

PATCH https://api.securitycenter.microsoft.com/api/machines/{machineId}

{
    "deviceValue": "Normal",
    "machineTags": [
                     "Demo Device",
                     "Generic User Machine - Attack Source",
                     "Windows 10" "Windows11",
                     "Windows Insider - Fast"
    ]
}

Tip

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