VTEX

This tutorial provides step-by-step instructions on how to rotate a VTEX API Key.


Generate a new VTEX API Key

Step 1 - Navigate to the API Keys page

Log into your VTEX admin account and navigate to https://{accountName}.myvtex.com/admin/api-keys.

Step 2 - Generate a new API Key

2a. Click Generate Key

2b. Provide Key identification, add roles and click Generate

Go to the link generated in the previous step, in the format https://share.vtex.com/credentials/{token}, where token is a random identifier generated when the key is created.

2e. Copy the Key and the New token and store it somewhere safe


Replace the Leaked VTEX API Key

Replace the leaked VTEX API Key with the new one in all impacted applications and services.


Revoke the Leaked VTEX API Key

Step 1 - Navigate to the API Keys page

Log into your VTEX admin account and navigate to https://{accountName}.myvtex.com/admin/api-keys.

Step 2 - Revoke the VTEX API Key

2a. Click Delete Key

Find the row of the API Key you want to delete and click the ellipsis menu , then click the Delete Key menu option.

2b. Confirm deletion

Check I understand that this action cannot be undone and click Delete to confirm.


Resources