Global vs. project-level API keys

Vercel DevOps for Jira can receive a Vercel API key either globally or per Jira project. This article explains the difference and when to use each option.

Global API key

A global API key is shared across all Jira projects on your site. To configure it:

1. Open the Atlassian administration for your site.
2. Navigate to the Connected apps section.
3. Find Vercel DevOps for Jira and click Configure.
4. Enter your Vercel API key and save.

The global API key is used as the default for all projects that do not have their own project-level key configured. It is also the key used to resolve Smart Links, since Smart Links operate outside of a project context.

Project-level API key

A project-level API key is specific to a single Jira project and overrides the global key within that project’s context. To configure it:

1. Open the Jira project.
2. Go to Project Settings and open the app under the Apps section.
3. Click the cog symbol to open the settings.
4. Enter a project-specific Vercel API key and save.

This is useful when different Jira projects need access to different Vercel teams or scopes.

First-time setup

When using the app for the first time in a Jira project, the UI will prompt you to provide an API key. This key is stored as the project-level key for that project.

How the app decides which key to use