Getting data through the NXQL API

The NXQL API is the main interface that Nexthink offers for integrating Nexthink data with external information systems. While Finder investigations provide a user with the means to query the Nexthink database, investigations are not well adapted to be launched and processed by external programs. The NXQL API fills this gap by offering third-party applications a standard programming interface to query the Nexthink database. The Engine implements the NXQL API as a RESTful web service over HTTPS. As such, the NXQL API can accept requests from any external application that supports the HTTP protocol over TLS/SSL (HTTPS). The default port for connecting to the NXQL API is 1671, for Engines on-premises, and 443, for Engines on the Nexthink Cloud. Since the NXQL API uses well-established Internet protocols for communicating with external applications, many tools support them directly. Information systems such as Configuration Management Databases or Issue Tracking Systems are typically able to access RESTful web services. These systems can quickly benefit from the integration of Nexthink data by querying the NXQL API.

Build advanced queries using NXQL, the Nexthink Query Language, to satisfy your most demanding integration needs. Send queries using either the GET or POST methods of the HTTPS protocol and receive the results of your queries in the format of your choice: XML, JSON, HTML or CSV.

Prerequisites

In order for the protocols of the NXQL API to work, set the External DNS name of the Engine to an appropriate value.

If your Engine is installed on-premises behind a Firewall, remember to open access to the default TCP port for the NXQL API (1671), or to the port number that you have configured instead.

---

RELATED TASKS

• Introducing the NXQL API V2

• NXQL Tutorial

• Setting the names of the Engines