API explorer content

This commit is contained in:
Joey Caparas 2019-08-06 17:08:32 -07:00
parent c019ac76b3
commit f45824a047

View File

@ -1,8 +1,8 @@
---
title: API explorer in Microsoft Defender ATP
ms.reviewer:
description:
keywords:
description: Use the API explorer to construct and perform API queries, test and send requests for any available API
keywords: api, explorer, send, request, get, post,
search.product: eADQiWindows 10XVcnh
search.appverid: met150
ms.prod: w10
@ -19,4 +19,38 @@ ms.topic: conceptual
---
# API explorer
With the API explorer you can quickly get started with trying out
The Microsoft Defender ATP API explorer is a tool that helps you explore various Microsoft Defender ATP APIs interactively.
The API explorer makes it easy to construct and perform API queries, test and send requests for any available API.
The tool is useful during app development because it allows you to perform API queries that respect your user access settings, reducing the need to generate access tokens.
You can also use the tool to explore the gallery of sample queries, copy result code samples, and generate debug information.
With the API explorer, you can:
- Run requests for any method and see responses in real-time
- Quickly browse through the API samples and learn what parameters they support
- Make API calls with ease; no need to authenticate beyond the management portal sign-in
## Access API explorer
From the left navigation menu, select **Partners & APIs** > **API explorer**.
## Supported APIs
API explorer supports all the APIs offered by Microsoft Defender ATP.
The list of supported APIs is available in the [APIs documentation](https://docs.microsoft.com/windows/security/threat-protection/microsoft-defender-atp/apis-intro).
## Get started with the API explorer
1. In the left pane, there is a list of sample requests that you can use.
2. Follow the links and click **Run query**.
Some of the samples may require specifying a parameter in the URL, for example, {machine- id}.
## FAQ
**Do I need to have an API token to use the API explorer?** <br>
Credentials to access an API are not needed since the API explorer uses the Microsoft Defender ATP management portal token whenever it makes a request.
The logged-in user authentication credential is used to verify that the API explorer is authorized to access data on your behalf.
Specific API requests are limited based on your RBAC privileges; for example, a request to "Submit indicator" is limited to the security admin role.