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:
Access the API Key configuration.
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:
Go to the Snyk API & Web app.
Go to the Settings dropdown menu at the bottom-left corner of the navigation bar and click on API Keys.
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:
Name - Type a meaningful name for the API Key. For example, “Azure DevOps Integration” or "My App Integration with Snyk API & Web"
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.(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.