> For the complete documentation index, see [llms.txt](https://docs.nexthink.com/platform/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.nexthink.com/platform/configuring_nexthink/bringing-data-into-your-nexthink-instance/integrating-nexthink-with-third-party-tools/api-and-integrations-classic/other-integrations-classic/list-engines-api-classic.md).

# List Engines API (classic)

## Overview <a href="#listenginesapi-classic-overview" id="listenginesapi-classic-overview"></a>

The *List Engines API* lets you programmatically retrieve the connection status and details of all the Engines linked to Portal.

The client of the List Engines API must trust the certificate in the primary Appliance (Portal).

To authenticate the client, the List Engines API uses Basic Authentication. Nexthink recommends creating a local account to exclusively authenticate clients of the API.

## Authentication <a href="#listenginesapi-classic-authentication" id="listenginesapi-classic-authentication"></a>

### **User account** <a href="#listenginesapi-classic-useraccount" id="listenginesapi-classic-useraccount"></a>

To authenticate the client, the List Engines API supports Basic Authentication. Nexthink recommends creating a local account to exclusively authenticate clients of the API.

### **OAuth** <a href="#listenginesapi-classic-oauth" id="listenginesapi-classic-oauth"></a>

You can configure Nexthink to grant access to the List Engines API using the open standard for access delegation, OAuth. Contact [Nexthink Support](https://support.nexthink.com/) for more information.

## Querying the API <a href="#listenginesapi-classic-queryingtheapi" id="listenginesapi-classic-queryingtheapi"></a>

### User account <a href="#listenginesapi-classic-useraccount.1" id="listenginesapi-classic-useraccount.1"></a>

To query the List Engines API, send the following GET request without parameters to Portal:

`https:///api/configuration/v1/engines`

Substitute `<Portal_DNS_FQDN>` with the actual name of Portal.

### OAuth <a href="#listenginesapi-classic-oauth.1" id="listenginesapi-classic-oauth.1"></a>

To query the List Engines API, send the following GET request without parameters to Portal:

`https://agora.<region>.nexthink.cloud/api/configuration/v1/engines`

Where `<region>` must match the region of your Nexthink Experience platform, as assigned to your organization during the onboarding.

The Enrichment API is currently available for the following regions:

* eu
* meta
* pac
* us

## Output of the List Engines API <a href="#listenginesapi-classic-outputofthelistenginesapi" id="listenginesapi-classic-outputofthelistenginesapi"></a>

The data that you can retrieve from the List Engines API is similar to what you get from the Engines dashboard when you connect Portal to the Engines.

The output holds the list of Engines in JSON format. For each Engine, find:

| Output data | Description                                                                                                                                                                              |
| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| name        | The name of the Engine                                                                                                                                                                   |
| databaseUID | The UID of the Engine database                                                                                                                                                           |
| machineID   | The ID of the machine that runs the Engine                                                                                                                                               |
| description | The description that the administrator gave to the Engine when connected .                                                                                                               |
| status      | <p>The status of the connection between Portal and the Engine:</p><ul><li><strong>CONNECTED</strong></li><li><strong>DISCONNECTED</strong></li><li><strong>CONNECTING</strong></li></ul> |
| address     | The IP address of the Engine                                                                                                                                                             |
| port        | The TCP port number where the Engine listens for the connection of Portal.                                                                                                               |
| timezone    | The time zone configured in the Engine.                                                                                                                                                  |
| version     | The version number of the Engine.                                                                                                                                                        |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.nexthink.com/platform/configuring_nexthink/bringing-data-into-your-nexthink-instance/integrating-nexthink-with-third-party-tools/api-and-integrations-classic/other-integrations-classic/list-engines-api-classic.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.