Management API

Notice

The Management API is a private preview feature. To enable this feature, please file a request with Support.

SingleStore provides the Management REST API to create and manage clusters. This RESTful API allows you to perform the following cluster operations:

  • Create clusters

  • Update clusters

  • Suspend/resume clusters

  • Terminate clusters

  • Generate a list of available clusters

  • Request information on available clusters

  • Generate a list of available regions

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 SingleStore customer portal.

To learn more, visit the following topics: Management API Overview and API Reference.