# Container App API Keys

> **📝 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.

   ![Select View API Keys button in Cloud Function.](https://images.contentstack.io/v3/assets/bltac01ee6daa3a1e14/bltf0817e39760a2add/6a3c4aeb325e48503535e541/Screenshot_2025-11-19_at_2_21_16_PM-pztQJO.png)

4. Select **Create API Key**.

   ![Shows an option of creating API key by selecting +Create API Key in upper right corner of app instance](https://images.contentstack.io/v3/assets/bltac01ee6daa3a1e14/blt7ee64a29d9a76cc3/6a3c4b6ac7b9ab01180798f3/Screenshot_2025-07-17_at_2_46_23_PM-zuiQKU.png)

5. In the **Create API key for \<Container\_App> - \<Container\_App\_name>&#x20;**&#x64;ialog,

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

   2. In **Expiration**, select the expiration date.

      ![Shows the way of creating an API key in the dialog box. Enter the API key name.](https://images.contentstack.io/v3/assets/bltac01ee6daa3a1e14/blt5525dd8a53d8243b/6a3c4af1d052f5665e855727/Screenshot_2025-08-14_at_6_18_57_PM-Na4jQg.png)

   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](https://docs.singlestore.com/cloud/developer-resources/secrets.md)**. The API key is displayed only **once**.

   ![Shows the generated API key and you can save the API key as secret and copy as well.](https://images.contentstack.io/v3/assets/bltac01ee6daa3a1e14/blt94176f022e56c8bc/6a3c4aff6610fdf3361654f1/Screenshot_2025-07-17_at_11_29_56_AM-v0a19T.png)

7. If **Save As Secret** is selected:

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

      ![Shows the way to save the API key as secret.](https://images.contentstack.io/v3/assets/bltac01ee6daa3a1e14/blte4e76a1f373e80a0/6a3c4b00e3036b13f1df0759/Screenshot_2025-07-17_at_2_48_35_PM-ogLoUE.png)

   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.

   ![](https://images.contentstack.io/v3/assets/bltac01ee6daa3a1e14/blte7bd8d8f49d6951a/6a3c4aea221be8905e71ceee/Screenshot_2025-11-19_at_2_27_13_PM-BnGqAS.png)

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.

         ![Shows the Active API keys in the cloud function app instance.](https://images.contentstack.io/v3/assets/bltac01ee6daa3a1e14/blt73e69bfa4c5b8f47/6a3c4c36f6306b714ef1e5de/Screenshot_2025-07-17_at_2_50_41_PM_copy-jepvYL.png)

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

         ![Shows the way to delete the Active API key in the Actions column.](https://images.contentstack.io/v3/assets/bltac01ee6daa3a1e14/bltbb18140a7abd2f9b/6a3c4bf87a816463a3edd820/Screenshot_2025-07-17_at_2_50_41_PM-hzGOar.png)

      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.

         ![Shows the orphaned API keys in the app instance.](https://images.contentstack.io/v3/assets/bltac01ee6daa3a1e14/blt009eb7bc9ae42f46/6a3c4afe5676bd34af96fb98/Screenshot_2025-07-17_at_12_57_11_PM_copy-dEBoVO.png)

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

         ![Shows the way to delete the orphaned API key in the App instance.](https://images.contentstack.io/v3/assets/bltac01ee6daa3a1e14/blt8be84867ae5de1b7/6a3c4c2ae1c1de1d14448a0a/Screenshot_2025-07-17_at_12_57_11_PM-MWGCfl.png)

      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.

   ![Select View API Keys button in any Aura app interface.](https://images.contentstack.io/v3/assets/bltac01ee6daa3a1e14/blt8e7bd30730da1cad/6a3c4c1af14f8eb64c0ba019/Screenshot_2025-11-21_at_11_06_16_AM-EEvN4H.png)

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.

         ![Shows the Active API keys in Cloud function App.](https://images.contentstack.io/v3/assets/bltac01ee6daa3a1e14/bltc72cfb46078fc78b/6a3c4c0a221be8f29c71cefc/Screenshot_2025-07-17_at_2_53_47_PM_copy-rjOiCQ.png)

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

         ![Shows the way of deleting the Active API key in the Cloud Function App.](https://images.contentstack.io/v3/assets/bltac01ee6daa3a1e14/blt8202a8dc9f899f8e/6a3c4c3ed052f5f915855761/Screenshot_2025-07-17_at_2_53_47_PM-hRV9SJ.png)

      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.

         ![Shows the orphaned API keys in the Cloud function App.](https://images.contentstack.io/v3/assets/bltac01ee6daa3a1e14/blt1187632c8c169d5c/6a3c4c3a6c72ee6033bfcf53/orphaned_tab-aY5TNZ.png)

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

         ![Shows the way of deleting the orphaned API keys.](https://images.contentstack.io/v3/assets/bltac01ee6daa3a1e14/blt2a8de27122f47a76/6a3c4c16d052f5162d85575f/Screenshot_2025-07-17_at_12_51_53_PM-eVf4sw.png)

      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.

***

Modified at: February 24, 2026

Source: [/cloud/container-services/container-app-api-keys/](https://docs.singlestore.com/cloud/container-services/container-app-api-keys/)

(An index of the documentation is available at /llms.txt)