Access the Data API
SingleStore's Data API can be accessed using Basic and Bearer Authentication methods at
protocolis HTTPS/HTTP; protocol must be HTTPS when SSL is enabled
hostnamerepresents the host where SingleStoreDB is running
portis the secure WebSocket proxy port configured
versionis the Data API version; currently v1 and v2 are supported
To access SingleStore’s 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 would appear 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 will then encode the
username:password string using Base-64 and insert it in an Authorization header before sending the HTTP request to the server.
Here's an example of using Bearer Authentication to access the Data API via cURL:
curl -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.C1um3oUNP4178sTG9WahtfZxN0-GqnYTPsbx-zhH9Qk" https://hostname:port/api/v2/exec
You can use API development tools and libraries to send Data API requests and handle responses.
Last modified: May 9, 2023