SingleStore provides the Management REST API to create and manage workspace groups and workspaces. This RESTful API allows you to perform the following operations:

• Workspace groups: Create, update, or delete workspace groups, request information on available workspace groups, list the workspace groups

• Workspaces: Create, update, suspend, resume, or delete workspaces, request information on workspaces, list the workspaces, get the outbound allowlist for a workspace

• Private connections: Create, update, or delete private connections, request information on private connections

• Teams: Create, update, or delete a team for the current organisation, request information on a team, list the teams

• Jobs: Create, update, or delete a job, request information on jobs, list the jobs

• Stage:

  • Create, update, or delete a folder in a Stage, request information on a folder

  • Upload, download, modify, or delete a file in a Stage

• Files: Create, upload, update, download, or delete a file in the personal, shared, or model space, list the files, request information on a file

• Secrets: Create, update, or delete a secret, request information on a secret, list the secrets

• Audit logs: Request Control Plane audit log entries

• Organizations: Request information on current organization

• Billing: Get raw compute and storage usage information for your organization

• Shared Edition: Update or remove a user

• Regions: 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. API calls made over HTTP will fail. The 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.