Data API Endpoint Reference

SingleStore currently supports the following API endpoints:

API Endpoint URL

Description

/api/v2/exec

Executes a SQL statement without returning result sets; typically used for executing DDL and DML statements for which result sets are not expected, such as CREATE TABLE and INSERT statements.

/api/v2/jwks_setup

Triggers update of the JWKS used by the Data API. Once the JWKS is updated and validated, the Data API will use the corresponding jwks_endpoint to authenticate requests to the API.

/ping

Verifies that the HTTP service is running and connectable.

/api/v2/query/rows

Executes a SQL statement and returns result sets; typically used for the SELECT statement for which result sets are expected. The result sets contain column names mapped to row values in a single field.

/api/v2/query/tuples

Executes a SQL statement and returns result sets along with the schema; typically used for the SELECT statement for which result sets are expected. The result sets contain rows and columns in separate fields with the schema displayed for each column.

/api/v2/spec

Returns the OpenAPI 3.0 specification for this service.

Note

The difference between /query/rows and /query/tuples endpoints lies in how the query results are presented in the JSON format. In addition, the /query/tuples endpoint offers better performance for queries with large result sets.

The HTTP request to the /ping endpoint does not require the SingleStore account credentials passed in an Authorization header.

In this section

Last modified: February 7, 2023

Was this article helpful?