Management API
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 team for the current organisation, request information on a team
-
Create, update, or delete a job, request information on jobs, list the jobs
-
Create, update, or delete a folder in a Stage, request information on a folder
-
Upload, download, modify, or delete a file in a Stage
-
Create, update, or delete a secret, request information on a secret, list the secrets
-
Request information on current organization, get raw compute and storage usage information for your organization
-
Request audit log entries
-
List the regions for a user
The 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, which can be generated on the Cloud Portal.
For information on the Management
API, refer to Management API Overview and Management API Reference.
You can also interface with the Management
API from SingleStore Notebooks using the Fusion SQL commands.
Last modified: February 14, 2025