Exporting API keys

2 min read

The API Keys page allows you to export information for all generated and external keys associated with the account to an XLSX file.

Before you begin

To export, you must have the User Administrator - RESTRICTED role or a custom role with the View API Keys resource.

Follow the instructions below to export keys:

In the top bar of the VTEX Admin, click your profile avatar, indicated by the initial letter of your email address.
Click Account Settings > API Keys.
Click Export. The file download will start instantly.

See the information available in the spreadsheet below.

Column	Description
`id`	API key identification code.
`keyName`	API key.
`roles`	Roles associated with the API key.
`label`	API key name, defined when creating the key.
`creationDate`	API key created date.
`creationDateToken`	If the key has a single token associated with it, this date indicates when the token was created. If the key is renewed, two tokens are associated with it. In this case, this date refers to when the token being replaced by the new one was created (the token that existed before the renewal process started).
`creationDateNewToken`	This field will be null if the key has a single token associated with it. If the key is in the renewal process, two tokens are associated with it. In this case, the field represents the date the new token that will replace the old one was created (in other words, the date renewal started).
`status`	API key status, which can be active or inactive.

Column	Description
`id`	API key identification code.
`keyName`	API key.
`roles`	Roles associated with the API key.
`account`	Name of the external account that owns the key.
`addedDate`	Date the external API key was added.
`status`	API key status, which can be active or inactive.