List Engines API (classic)
Overview
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
User account
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
You can configure Nexthink to grant access to the List Engines API using the open standard for access delegation, OAuth. Contact Nexthink Support for more information.
Querying the API
User account
To query the List Engines API, send the following GET request without parameters to Portal:
https://<Portal_DNS_FQDN>/api/configuration/v1/engines
Substitute <Portal_DNS_FQDN> with the actual name of Portal.
OAuth
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
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 | The status of the connection between Portal and the Engine:
|
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. |