Sign inTry Free

Container App API Keys

On this page

Note

This is a Preview feature.

Container App API keys allow you to programmatically interact with SingleStore Aura environment. These keys are used to authenticate requests to Container App APIs, which enables automation, integration with CI/CD pipelines, and secure service-to-service communication. A Container App API key can be created for and used to access any Container App, such as Cloud Functions and Dashboard Apps. The API key is unique and only enables access to the Container App for which it is created.

Create a Container App API Key

To create an API key, perform the following steps:

  1. In the Cloud Portal, under the Container Services section, navigate to a Container App.

  2. Select an App instance. An example with a Cloud Function App is demonstrated.

  3. Select View API Keys in the upper right corner.

  4. Select Create API Key.

  5. In the Create API key for <Container_App> - <Container_App_name> dialog,

    1. Enter the name in the API Key Name field.

    2. In Expiration, select the expiration date.

    3. Select Create API Key.

  6. Once the API key is generated, select Copy API Key to copy it or Save As Secret to store it securely in Secrets. The API key is displayed only once.

  7. If Save As Secret is selected:

    1. In the New Secret dialog, enter the name for the secret in the Name field.

    2. Select Create Secret. The API key is stored in a secret.

  8. Select Close.

Types of Container App API Keys

There are two types of Container App API keys:

  1. Active API key: An API key that is currently valid, associated with an existing App instance or user, and has not been revoked. It can successfully authenticate requests to the Container App APIs.

  2. Orphaned API key: An API key that is not associated with an existing App instance, as the App or user that created it, was deleted. Orphaned keys are inactive and cannot be used to authenticate API requests.

    Note

    Orphaned API keys pose a potential security risk and should be identified and revoked promptly.

Manage a Container App API Key

You can manage a Container App API key in two ways:

  1. Using the App instance

  2. Using the Container Service

Using the App Instance

  1. Navigate to the Container Service.

  2. Under the Name column, select the App instance for which you want to manage the Container App API key.

  3. Select View API Keys in the upper right corner. You can view the total number of API keys for the App instance on the View API Keys button.

  4. To revoke an active or orphaned Container App API key, perform the following tasks:

    1. Revoke an Active Container App API key:

      1. Navigate to the Active tab.

      2. Select the delete icon under the Actions column next to your API key.

      3. In the Revoke API key dialog, enable the agreement and select Revoke.

    2. Revoke an Orphaned Container App API key:

      1. Navigate to the Orphaned tab.

      2. Select the delete icon under the Actions column next to your API key.

      3. In the Revoke API key dialog, enable the agreement and select Revoke.

        Note

        Orphaned keys can only be revoked by the Aura Owner or Owner of the organization.

Using the Container Service

  1. Navigate to the Container Service.

  2. Select View API Keys in the upper right corner.

  3. To revoke an active or orphaned Aura App API key, perform the following tasks:

    1. Revoke an Active Container App API key:

      1. Navigate to the Active tab.

      2. Select the delete icon under the Actions column next to your API key.

      3. In the Revoke API key dialog, enable the agreement and select Revoke.

    2. Revoke an Orphaned Container App API key:

      1. Navigate to the Orphaned tab.

      2. Select the delete icon under the Actions column next to your API key.

      3. In the Revoke API key dialog, check the agreement and select Revoke.

        Note

        Orphaned keys can only be revoked by Aura Owner or Owner of the organization.

Last modified:

Was this article helpful?

On this page

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

Try Out This Notebook to See What’s Possible in SingleStore

Get access to other groundbreaking datasets and engage with our community for expert advice.

Sign UpLog In