Snyk is a software security platform. By integrating Snyk with DX, you can analyze security issues and map them to services, repositories, and teams. Please visit our schema explorer to see what data DX imports.

Prerequisites

To connect Snyk to DX, you need:

a Snyk account with admin access
API access (i.e., Enterprise plan)

Setup instructions

Follow the steps below to connect Snyk to DX.

Step 1

To access Snyk APIs, you can authenticate using either an Individual User Token or a Service Account Token (recommended).

To generate an API token, go to Account Settings > API Token in your Snyk profile:

To generate an API token for a Service Account, go to Organization Settings > Service Accounts. The service account needs the following read permissions:

View Organization Reports: Lists reporting issue counts.
View Organization: Allows DX to get a flattened list of all projects across all orgs.
View Project History: Allows DX to get project history.
View Project: Lists issues for a project.

Step 2

Navigate to the new connection form in DX.
Enter the credentials you have generated in the previous steps—refer to the information below for errors and troubleshooting.

API Reference

The table below lists the specific API endpoints that are used by DX.

Endpoint	Reference
/orgs	Snyk API: List Organizations
/orgs/{id}/projects	Snyk API: List organization projects
/orgs/{id}/issues	Snyk API: List Project issues

Errors

The table below lists potential error codes when adding a connection in DX.

Error	Description
`invalid_credentials`	Your API credentials entered are not valid.
`invalid_permissions`	Your API token does not have the permissions required by DX.