Key Lifecycle
This guide walks you through the lifecycle of API keys, including suspending, reinstating, and deleting keys.
Suspend a Key
Suspending a key can be useful when you want to temporarily stop its usage without permanently deleting it. For example, if you suspect unauthorized usage of an API key or if the associated application is under maintenance, you can suspend the key to prevent any access until the issue is resolved.
To suspend a key:
- Navigate to the API keys management section in your dashboard.
- Locate the key you wish to suspend.
- Click the Suspend button.
Example Scenario
Let’s say you have an API key used by a third-party service. If you notice unusual activity or a security concern, suspending the key temporarily ensures no further calls are made until you investigate the issue.
Reinstate a Key
If you have suspended a key and resolved the issues that led to its suspension, you can reinstate it to restore its functionality. Only suspended keys can be reinstated.
To reinstate a key:
- Go to the suspended keys section in your dashboard.
- Find the key you want to reactivate.
- Click the Reinstate button.
Example Scenario
After maintenance or resolving a security issue, you can reinstate the key to allow normal operations to resume for your application.
Delete a Key
Deleting a key is a permanent action that should be used when the key is no longer needed. Only suspended keys can be deleted, providing an extra layer of security to prevent accidental deletion of active keys.
To delete a key:
- Ensure the key is suspended.
- Navigate to the suspended keys section.
- Select the key you want to delete and click the Delete button.
Important Note
Once a key is deleted, it cannot be recovered. Ensure that the key is no longer required before performing this action.
Summary
- Suspend a Key: Temporarily disable a key to prevent its usage.
- Reinstate a Key: Reactivate a suspended key when ready.
- Delete a Key: Permanently remove a key, only available for suspended keys.