Menu
Feedback
Start here
Tutorials
Developer portal

Known Issues
Support Rules
Troubleshooting

Frequently Asked Questions
Announcements
Tutorials
Tutorials
Explore in-depth tutorials for operating your VTEX store.
Tutorials
Beta
API Keys Beta
Configuring the duration of API keys (Beta)
Configuring the duration of API keys (Beta)

This feature is in closed beta, so only selected clients can access it now. If you are interested in implementing it in the future, please contact our Support team.

The API Keys page allows you to configure the duration of the API tokens generated when you create a key. Setting the duration of API keys is important to guarantee security, limit exposure to risks, control access to resources, and minimize the impact of compromised keys.

By default, the duration applied to API keys is three months unless another option is selected.

When the set deadline is reached, the API key will appear as Outdated in the Generated tab.

During the beta phase, the duration only changes the status in the VTEX Admin interface without preventing the use of the key. We recommend manually renewing the token of outdated keys.

To configure the duration of API tokens, follow the steps below:

  1. In the top bar of the VTEX Admin, click your profile avatar — indicated by the first letter of your email — and then click Account Settings > API Keys.

  2. Click Settings.

  3. Select the option for the desired duration:

    • 3 months (recommended)
    • 6 months
  4. Click Apply.

This period will apply to all new and existing keys, using the created date as the reference for calculating the duration.

Learn more

Contributors
2
Photo of the contributor
Photo of the contributor
+ 2 contributors
Was this helpful?
Yes
No
Suggest Edits (GitHub)
Contributors
2
Photo of the contributor
Photo of the contributor
+ 2 contributors
On this page
Still got questions?
Ask the community
Find solutions and share ideas in the VTEX community.
Join our community
Request support from VTEX
For personalized assistance, contact our experts.
Open a support ticket
GithubDeveloper portalCommunityFeedback