How to create a Vercel API token?

Owned by Sebastian Hesse
Last updated: Aug 20, 2024
2 min read

Vercel for Compass needs an API token to talk to Vercel’s API. You can create one by following this article.

  1. Go to vercel.com and login

  2. Click on your user icon in the upper right corner and click on Account Settings:

    vercel-select-account-settings.png

  3. In the tabs at the top, open “Settings” > “Tokens” and the following page should appear:

    vercel-account-settings-token.png

  4. To create the token, give it a proper name like “Vercel for Compass Token”, select a scope that allows to access the projects you’d like to import later and set an expiration date:

    vercel-create-token-for-vercel-for-compass.png

  5. After clicking “Create”, a dialog appears containing a token:

    vercel-created-token-success.png


    You copy that token and paste it into the token input field in Vercel for Compass (either when opening the app the first time or when opening the settings).

 

Vercel for Compass is storing the token in Atlassian’s Forge Storage for secrets. It won’t leave the Atlassian systems! Furthermore, you don’t have to save it somewhere for yourself as you can delete the token in your Vercel Settings at any time and generate a new token if necessary.

Website | Privacy | Legal