March 16, 2025
+ 12
The Query Service provides REST APIs for executing SQL++ statements, administering Query Service nodes, configuring the Query Service, and managing the JavaScript libraries used to create SQL++ user-defined functions.

APIs in this Section

For a list of the methods and URIs covered in these pages, see the tables below.

Query Service REST API

Use the Query Service REST API to execute SQL++ statements. This REST API uses ports 8093 and 18093.

HTTP Method URI Documented at

POST

/query/service

Query Service

GET

/query/service

Read-Only Query Service

Query Admin REST API

Use the Query Administration REST API to administer the Query Service at the node level. This REST API uses ports 8093 and 18093.

HTTP Method URI Documented at

GET

/admin/clusters

Read All Clusters

GET

/admin/clusters/{cluster}

Read a Cluster

GET

/admin/clusters/{cluster}/nodes

Read All Nodes

GET

/admin/clusters/{cluster}/nodes/{node}

Read a Node

GET

/admin/config

Read Configuration

GET

/admin/prepareds

Retrieve All Prepared Statements

GET

/admin/prepareds/{name}

Retrieve a Prepared Statement

DELETE

/admin/prepareds/{name}

Delete a Prepared Statement

GET

/admin/indexes/prepareds

Retrieve Prepared Index Statements

GET

/admin/active_requests

Retrieve All Active Requests

GET

/admin/active_requests/{request}

Retrieve an Active Request

DELETE

/admin/active_requests/{request}

Delete an Active Request

GET

/admin/indexes/active_requests

Retrieve Active Index Requests

GET

/admin/completed_requests

Retrieve All Completed Requests

GET

/admin/completed_requests/{request}

Retrieve a Completed Request

DELETE

/admin/completed_requests/{request}

Delete a Completed Request

GET

/admin/indexes/completed_requests

Retrieve Completed Index Requests

GET

/admin/vitals

Retrieve Vitals

GET

/admin/stats

Retrieve All Statistics

GET

/admin/stats/{stats}

Retrieve a Statistic

GET

/admin/settings

Retrieve Node-Level Query Settings

POST

/admin/settings

Update Node-Level Query Settings

GET

/admin/ping

Ping

GET

/admin/gc

Run Garbage Collector

POST

/admin/gc

Run Garbage Collector and Release Memory

Query Settings REST API

Use the Query Settings REST API to configure the Query Service at the cluster level. This REST API uses ports 8091 and 18091.

HTTP Method URI Documented at

GET

/settings/querySettings

Retrieve Cluster-Level Query Settings

POST

/settings/querySettings

Update Cluster-Level Query Settings

GET

/settings/querySettings/curlWhitelist

Retrieve CURL Access List

POST

/settings/querySettings/curlWhitelist

Update CURL Access List

Query Functions REST API

Use the Query Functions REST API to manage the JavaScript libraries and objects used to create SQL++ user-defined functions. This REST API uses ports 8093 and 18093.

HTTP Method URI Documented at

GET

/evaluator/v1/libraries

Read All Libraries

GET

/evaluator/v1/libraries/{library}

Read a Library

POST

/evaluator/v1/libraries/{library}

Create or Update a Library

DELETE

/evaluator/v1/libraries/{library}

Delete a Library

See Also

For an explanation of how cluster-level settings, node-level settings, and request-level parameters interact, see Configure Queries.