Edit

Share via


Get domain-related machines API

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 a collection of Machines that have communicated to or from a given domain address.

Limitations

  • You can query on devices last updated according to your configured retention period.
  • Rate limitations for this API are 100 calls per minute and 1500 calls per hour.
  • Responses are limited to 500 devices in results.

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.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 must have at least the following role permission: View Data. For more information, see Create and manage roles.
  • Responses include only devices that the user can access, 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

GET /api/domains/{domain}/machines

Request headers

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

Request body

Empty

Response

If successful, and the domain exists:

  • 200 OK with list of machine entities

If domain doesn't exist:

  • 200 OK with an empty set

Example

Request

Here's an example of the request.

GET https://api.securitycenter.microsoft.com/api/domains/api.securitycenter.microsoft.com/machines

Tip

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