Using LoopBack API Explorer to explore API requests
NAVIGATION https://<your instance URL>/explorer/#/
SECURITY Datto EDR subscription with administrator or analyst-level platform access
This article explains how to use the LoopBack API Explorer to inspect the Datto EDR API.
Overview
The LoopBack API Explorer is a web-based application that empowers you to visually inspect the Datto EDR API. With the LoopBack Explorer, you can view all of the available API entities and their functions, construct test requests, and view query results.
Use the LoopBack Explorer if
- you'd like to browse the structure of the API from an all-in-one view.
- you'd like a comprehensive index of call examples for all API entities.
- you'd like to be able to generate sample API output from a point-and-click interface.
Proceed to the next section of this article to learn how to get started with the application. For LoopBack application support, visit LoopBack's website.
Accessing your LoopBack API Explorer instance
-
In a web browser, navigate to https://<your instance URL>/explorer/#/. Replace <your instance URL> with the URL of your EDR instance.
-
LoopBack API Explorer will load.
EXAMPLE https://demo.infocyte.com/explorer/#/
Navigating the interface
LoopBack API Explorer lists all available API entities that relate to different areas of the product. You can expand or collapse the entity list to expose varying levels of detail. When expanded, each entity shows the syntax of its available operations, along with the request method (e.g., GET, POST, PUT PATCH, or DELETE) and sample values.
When collapsed, the list shows entity names only. You can click each entity's name to expand it and view a higher level of detail.
To view granular information about a specific operation, click its name in the expanded entity view.
The expanded request detail may include the following sections:
| Section | Description |
|---|---|
| accessToken | When making requests to the API, enter your access token in this field. To learn how to create an API token, refer to Generating Datto EDR API tokens |
| Model | The Model field displays the syntax structure that responses to this function will return. |
| Parameters | This field enables you to enter test parameters for the selected function and see the corresponding result. |
|
Curl |
The curl syntax for this request appears here. |
|
Request URL |
This field provides the full path to the selected entity. |
|
Response Body |
The body of the response resulting from the test request will appear here. |
|
Response Code |
Sample and actual responses that you may receive when calling the entity with the selected query. |
|
Response Headers |
Sample and actual responses that you may receive when calling the entity with the selected query. |
Making a test request
To make a test request to the API, perform the following steps:
1. Select an entity and a query type.
2. In the expanded request detail window, click Try it out.
3. The response fields will populate. Enter your desired parameters in the Parameter > Value box. When you're ready to run the query, click Try it out!
4. When you're ready to run the query, click Try it out!
5. Responses to your query will appear in the Response Body, Response Code, and Response Header sections of the page for the selected entity.
Troubleshooting
If you're not able to see any output, or you're receiving unexpected responses, be sure to check the Response Code field. The LoopBack API explorer uses standard HTTP Status Codes.
