APIΒΆ

SpectX provides a REST API for executing queries. This provides a simple and straightforward way to integrate external applications with SpectX.

You can execute query scripts stored in SpectX as well as queries specified in the request and fetch the contents of .sxt tables.

A sample client implementation in Java is available on GitHub.

API root endpoint:

https://<host>:<port>/API/v1.0/

Hint

use Properties/API Access menu (right-click on script file) to generate a sample request using curl utility.

API Subsets

The API is divided into two subsets - synchronous and asynchronous.

The synchronous API takes less effort to implement on the client-side but provides less control over aspects of query execution, while the asynchronous API provides fine-grained control.