Access the Data API
Data API can be accessed using Basic Authentication method at protocol://hostname:port/api/version/ where:
-
protocolis HTTPS/HTTP; protocol must be HTTPS when SSL is enabled. -
hostnamerepresents the IP address or hostname of the SingleStore deployment. -
portis the secure WebSocket proxy port configured. -
versionis the Data API version; currently v1 and v2 are supported.
To access SingleStore Data API via Basic Authentication, you need to provide your SingleStore account credentials (username and password) in each HTTP request.username:password string in the Authorization header in the HTTP client.demo:Afu4XjzB1ns appears as follows.
Authorization: Basic ZGVtbzpBZnU0WGp6QjFucw==
Using an HTTP client such as cURL, you can either pass your credentials as parameters in the --user or the -u option or add them before the hostname in the HTTP request, as shown below.
curl -u "username:password" https://hostname:port/api/v2/exec
curl https://username:password@hostname:port/api/v2/exec
cURL encodes the username:password string using Base-64 and inserts it in the Authorization header before sending the HTTP request to the server.
You can use API development tools and libraries to send Data API requests and handle responses.
Last modified: September 26, 2025