[VORTEX Portal] How to Manage for API Key?

API keys are unique authentication tokens that enable secure access to API services. These credentials verify user identity and authorization level when making API requests.

Note: This feature is only available to users with the VORTEX xPro License (Licensed ) and is not supported for users of the Free Cloud-Managed Service (Unlicensed).

API Key Life Cycle

The API key follows a progression:

• Creation - Generation of a secure token through the Portal
• Implementation - Use the API key to obtain API access permissions
• Expiration - Termination of key validity at the predefined endpoint

Note: Once a key expires, it is automatically deactivated.

Creating an API Key

To generate a new API key:

1. Log in to the Portal and click on your account picture

2. Select "My Account"

3. Select "API Key Management" from the left menu

4. Click "Add" to generate a new API key

5. Enter your password to verify your identity

6. Provide a name to identify this API key

7. Set the validity period for the API key according to your needs (default is "no expiration")

8. Click "Generate"
9. Upon success, the API key will appear. Please be sure to save it as it will only be displayed once

10. Click "Done"
11. The successfully generated API key will appear in the list on the page

Deleting an API Key

To delete an API key:

1. Log in to the Portal and click on your account picture

2. Select "My Account"

3. Select "API Key Management" from the left menu

4. Open API Key List

5. Move the mouse to the API key you want to delete. A "delete" icon will appear.

6. Click the "delete" icon.
7. Confirm to delete the API Key, click "Delete"

Please ensure the API Key you want to delete is no longer in use. After deletion, it will be rejected for API authentication.

8. Successfully deleted the API Key.