Management API Overview
On this page
SingleStore provides the
Management REST API to create and manage workspace groups and workspaces.
Create, update, or delete workspace groups, request information on available workspace groups, list the workspace groups
Create or delete workspaces, request information on workspaces, list the workspaces
Create, update, or delete private connections, request information on private connections
Create, update, or delete a folder in Stages, request information on a folder
Upload, download, modify, or delete a file in Stages
Request information on current organization
List the regions for a user
Management API supports HTTP Bearer authentication, which must be used in conjunction with SSL (HTTPS) for secure communication over the network.
Management API authenticates requests using a unique, hex-encoded alphanumeric key.
When a user is a member of multiple organizations, they can have multiple API keys, one for each organization.
Follow these instructions to generate API keys:
On the Cloud Portal, in the navigation pane, select your organization.
In the navigation pane, select API keys > Create API key.
Specify a name and expiration date for the API key, and select Create.
The API key is displayed only once.
To revoke an API key, navigate to the API keys section on the Cloud Portal.
API keys that are not manually revoked expire on the expiration date defined while creating the API key.
SingleStore recommends using IP Allowlist to secure inbound access to workspaces using the
To allow an IP address, login to the Cloud Portal.
By default, IP Allowlist is set to Allow access from anywhere, which allows access to anyone with the API key.
Management API supports HTTP Bearer authentication.
Authorization: Bearer 28790ecd46256d9024e7b21a737493b2ed2872e6883808a87843d1ce9839d0d3
While making API calls through an HTTP client (such as cURL), you can pass the API key using the
curl -X 'GET' \'api_endpoint_url' \-H 'accept: application/json' \-H 'Authorization: Bearer <API_key>'
A workspace is an independent logical deployment of compute resources which can be used to run a workload in lieu of a cluster.
Each workspace is a part of a workspace group, which allows configuration and management of workspaces.
Once a workspace becomes active, use the workspace endpoint to establish a SQL connection in conjunction with the admin user and password (password for the workspace group).
mysql -h svc-a6df2ae8-85cc-4c59-b26a-66516de053d8-1-dml.aws-cancentral-1.svc.singlestore.com -u admin --password='QUNL@S|(})jZX1VDOp%*EMzm'
After connecting to a workspace endpoint, execute the
CREATE DATABASE command to create the specified database and attach it to the workspace in the read-write mode.
Refer to Attach a Database to a Workspace for more information.
Refer to Detach a Database from a Workspace for more information.
The singlestore-go repository is a collection of SingleStore Golang SDKs.
management package in the Golang SDK can be used to interact with the
To import the SDK, add the following line to your
In this section
Last modified: September 27, 2023