Management API Overview

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

Authorization

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

If 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

To enable your account for API key authorization, contact SingleStore support. Once API key authorization is enabled, follow the instructions below to generate API keys:

  • On the SingleStore customer portal, in the navigation pane, select your organization.

  • In the navigation pane, select API keys > Create API key.

  • Specify a name and expiration date for the API key. Select Create.

Important

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

Revoke an API Key

To revoke an API key, navigate to the API keys section on the SingleStore customer portal. Select the ellipsis icon beside the API key, select Revoke.

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

Access the Management API

SingleStore’s Management API supports HTTP Bearer authentication. To access the API, you need to provide your API key in each HTTP request, in the Authorization header. An example Authorization header is as follows.

Authorization: Bearer 28790ecd46256d9024e7b21a737493b2ed2872e6883808a87843d1ce9839d0d3

While making API calls through an HTTP client (such as cURL), you can pass the API key using the -H parameter:

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