Management API

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

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

  • Create or delete workspaces, request information on workspaces, list the workspaces

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

  • Create, update, or delete a team for the current organisation, request information on a team

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

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

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

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

  • Request information on current organization, get raw compute and storage usage information for your organization

  • Request audit log entries

  • 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.

Last modified: February 14, 2025

Was this article helpful?

Verification instructions

Note: You must install cosign to verify the authenticity of the SingleStore file.

Use the following steps to verify the authenticity of singlestoredb-server, singlestoredb-toolbox, singlestoredb-studio, and singlestore-client SingleStore files that have been downloaded.

You may perform the following steps on any computer that can run cosign, such as the main deployment host of the cluster.

  1. (Optional) Run the following command to view the associated signature files.

    curl undefined
  2. Download the signature file from the SingleStore release server.

    • Option 1: Click the Download Signature button next to the SingleStore file.

    • Option 2: Copy and paste the following URL into the address bar of your browser and save the signature file.

    • Option 3: Run the following command to download the signature file.

      curl -O undefined
  3. After the signature file has been downloaded, run the following command to verify the authenticity of the SingleStore file.

    echo -n undefined |
    cosign verify-blob --certificate-oidc-issuer https://oidc.eks.us-east-1.amazonaws.com/id/CCDCDBA1379A5596AB5B2E46DCA385BC \
    --certificate-identity https://kubernetes.io/namespaces/freya-production/serviceaccounts/job-worker \
    --bundle undefined \
    --new-bundle-format -
    Verified OK