Skip to main content

How to generate an API Key

Learn how to generate API Keys to integrate with Snyk API & Web.

Ana Pascoal avatar
Written by Ana Pascoal
Updated over a month ago

To foster the automation of workflows and processes with other systems, Snyk API & Web provides API Keys for authentication purposes in the integration with third-party systems (e.g., Slack, Jira, Azure Boards, Azure DevOps, or Jenkins), as well as the integration of your own applications with Snyk API & Web using the Snyk API & Web API.

Generating an API Key has two steps:

  1. Access the API Key configuration.

  2. Configure, generate and save the API Key.

This article describes these steps in detail.

Step 1: Access the API Key configuration

Start by accessing the API Key configuration as follows:

  1. Go to the Settings dropdown menu at the bottom-left corner of the navigation bar and click on API Keys.

  2. Click on the Add API key button to open the configuration form.

Step 2: Configure, generate, and save the API Key

In the configuration form, fill out the following fields:

  1. Name - Type a meaningful name for the API Key. For example, “Azure DevOps Integration” or "My App Integration with Snyk API & Web"

  2. Role / Scope - Choose the roles that can use the API Key and at which level (scope). For example, “Admin” / “Global (account)”.
    Click on the plus ("+") button to add the pairs of roles and scopes.

  3. (Optional) Labels - Tag the API key with meaningful labels for filtering purposes.

Click on Generate key and copy and save the API Key.

IMPORTANT NOTE: This is the only time the API Key is displayed. So, make sure you copy and save it in a secure place.

With the API Key saved, proceed to the integration with third-party tools or the integration of your own applications with Snyk API & Web using the Snyk API & Web API.

Did this answer your question?