Resetting an API Key

Scenarios

You can manage API keys of your Supabase AI application, primarily by resetting a specified API key. Resetting an API key invalidates the previous key and generates a new one.

Prerequisites

• You have registered a Huawei ID and enabled Huawei Cloud services.
• You can create an IAM user and user group on the IAM console and grant the user specific operation permissions, to perform refined management on Huawei Cloud. For details, see Using IAM Roles or Policies to Grant Access to RDS.
• You must use a login account assigned the rds:aiApplication:listApiKey, rds:aiApplication:resetApiKey, rds:aiApplication:get, and rds:aiApplication:list actions.

Precautions

• Keep your API keys secure to prevent security risks, potential attacks, and business losses.

• When you reset an API key of a certain type, the system dynamically generates a new API key. After the new key is generated, the old API key is automatically invalidated.
• Only API keys in the normal state can be used for API calls. API keys that are being created, failed to create, or have expired cannot be used.

Constraints

• A Supabase application is created. API keys cannot be reset for Supabase applications that are being created or failed to create.
• The Supabase application is running properly and no active operations are being performed on it.
• Each API key type of a Supabase application supports only one active key. After a successful reset, the previous key becomes invalid.
• During the API key reset process, the Supabase application and its API features will be briefly unavailable (the currently active API key value will gradually become invalid). Perform this operation during off-peak hours to avoid affecting peak-hour workloads.
• Resetting an API key creates a workflow task. If the API key reset fails due to a sudden fault, you can reset the API key again after the fault is resolved.

Procedure

1. Log in to the RDS console.
2. Click in the upper left corner and select a region.
3. In the navigation pane, choose AI App Dev Platform.
4. On the AI App Dev Platform page, click the target AI application name to open its details page.
   Figure 1 RDS Supabase application details
   

5. In the navigation pane, choose API Key. The API key list is displayed.
   Figure 2 Application API key list
   

6. Select the target API key and click Reset in the Operation column. In the displayed dialog box, click OK to submit the API key reset workflow task.
   Figure 3 Resetting an API key
   

7. Refresh the API key list. You can see a new API key record in the Creating state. When the record status changes to Normal and the status of the old key changes to Invalidated, the new API key is created.
   Figure 4 API key status during reset (The new key appears with the status Creating.)
   
   Figure 5 API key status after a successful reset (The old key's status changes to Invalidated and the new key's status becomes Normal.)