# Management API

The SingleStore `Management` API provides a REST-based interface for provisioning, configuring, operating, and managing cloud resources within SingleStore Helios. The API is designed to support infrastructure automation, lifecycle management, and seamless integration with DevOps, CI/CD, and infrastructure-as-code workflows, enabling you to automate deployment pipelines, dynamically scale environments, enforce governance policies, manage operational workflows, and more.

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
* **Projects**: List the projects accessible to a user
* **Private connections**: Create, update, or delete private connections, request information on private connections
* **Flow**: Create or terminate a Flow instance, request information on a Flow instance, list the Flow instances
* **Invitations**: Invite a user, revoke an invitation, list the open invitations, request information on an invitation
* **Teams**: Create, update, or delete a team for the current organisation, request information on a team, list the teams
* **Users**: Add an existing user to the current organization, delete a user, request information on a user, list the users
* **Roles**: Create, update, or delete a custom role, request information on a role, list the roles
* **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** (Shared Tier):

  * Create or delete a Shared Edition deployment (starter workspace), request information on a starter workspace, list the starter workspaces
  * Create, update, or delete a user in a Shared Edition deployment
* **Cloud workload identity and delegated entities**: Request information on the cloud workload identity of a workspace, add or remove delegated entities, list the configured delegated entities
* **Regions**: List the regions for a user

The `Management` API supports [HTTP Bearer authentication](https://swagger.io/docs/specification/authentication/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](https://portal.singlestore.com/).

For information on the `Management` API, refer to [Management API Overview](https://docs.singlestore.com/cloud/reference/management-api.md) and [Management API Reference](https://docs.singlestore.com/cloud/reference/management-api/reference.md).

You can also interface with the `Management` API from [SingleStore Notebooks](https://docs.singlestore.com/cloud/container-services/notebooks.md) using the [Fusion SQL](https://docs.singlestore.com/cloud/reference/fusion-sql.md) commands.

***

Modified at: May 26, 2026

Source: [/cloud/user-and-workspace-administration/management-api/](https://docs.singlestore.com/cloud/user-and-workspace-administration/management-api/)

(An index of the documentation is available at /llms.txt)