Getting data through the Web API

Getting data through the Web API

Overview of the Web API

The Web 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 Web API fills this gap by offering third-party applications a standard programming interface to query the Nexthink database. The Engine implements the Web API as a RESTful web service over HTTPS. As such, the Web API can accept requests from any external application that supports the HTTP protocol over TLS/SSL (HTTPS). The default port for connecting to the Web API is 1671. Since the Web 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 Web API.

Starting from Nexthink V5.3, the Web API comes in two flavors:

Web API V2
The newest and most flexible version of the Web 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.
Web API V1 (deprecated)
The simple way to turn your Finder investigations into web-accessible queries. Build and publish your queries visually with the tools provided by the Finder. Access to those queries using the GET method of the HTTPS protocol and get results in XML format.

Prerequisites

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

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