Management API Overview

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:

• Cluster groups: Create, update, or delete cluster groups, request information on available cluster groups, list the cluster groups

• Clusters: Create, update, suspend, resume, or delete clusters, request information on clusters, list the clusters, get the outbound allowlist for a cluster

• 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 cluster), request information on a starter cluster, list the starter clusters

  • 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 cluster, add or remove delegated entities, list the configured delegated entities

• 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. For more information, refer to Authorization.

You can also interface with the Management API from SingleStore Notebooks using the Fusion SQL commands.

Authorization

The Management API authenticates requests using a unique, hex-encoded alphanumeric key. You can generate this API key on the Cloud Portal.

When a user is a member of multiple organizations, they can have multiple API keys, one for each organization. The API key defines the operations that a user can perform.

Generate an API Key

Follow these instructions to generate API keys:

1. On the Cloud Portal, in the navigation pane, select your organization.

2. In the navigation pane, select Configuration > API keys > Active Keys > Create API key.

3. Specify a name and expiration date for the API key, and select Create.

Important

The API key is displayed only once. Be sure to copy and securely store the API key.

Revoke an API Key

To revoke an API key, navigate to the API keys section under Configuration on the Cloud Portal. On the Active Keys tab, select the delete icon under the Actions column for the API key, and select Revoke.

API keys that are not manually revoked expire on the expiration date defined while creating the API key. A revoked API key cannot be reinstated.

Control Access to the API

SingleStore recommends using IP Allowlist to secure inbound access to clusters using the Management API.

To allow an IP address, login to the Cloud Portal. Under your organization, select Configuration > API Keys > Security > Edit > Only allow access from specified IP addresses. Under IP Allowlist, add the IP address to allow.

By default, IP Allowlist is set to Allow access from anywhere, which allows access to anyone with the API key.

Authorization: Bearer 28790ecd46256d9024e7b21a737493b2ed2872e6883808a87843d1ce9839d0d3

curl -X 'GET' \
  'api_endpoint_url' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <API_key>'

singlestore -h svc-xxxx-1-dml.aws-cancentral-1.svc.singlestore.com -u admin --password='QUNL@S|(})jZX1VDOp%*EMzm'

import "github.com/singlestore-labs/singlestore-go/management"