Getting started
Supported browsers
Snyk supports the latest versions of the following web browsers:
Safari (except for Opening Fix PR)
To start performing basic tasks in the Snyk application:
Create or log in to a Snyk account
To create a free account or sign up for a pricing plan, navigate to snyk.io. For details, see Snyk Pricing Plans.
If your company has an existing Snyk account and uses single sign-on (SSO), use the SSO link provided by your administrators.
If your company requires an invitation to use Snyk, when you log in for the first time, you may see a list of Organizations, which in Snyk control access to Projects. To request access to an Organization, select the name of an Organization Admin in order to request access.
When you log in to the Snyk Web UI, Snyk shows your preferred (default) Organization. Snyk also uses the settings for your preferred Organization when you test a Project locally using the CLI. To change your default Organization, see Manage account preferences and settings.
Set up a Snyk integration
For Snyk to know where to scan, you must provide it with access to your environment. The type of integration you need depends on what systems you use, what you want to scan, and where you want to add the integrations - Organization or Group. For information about available integrators, see Snyk SCM integrations and Integrate with Snyk.
To scan your code, you must first integrate Snyk with the repository holding that code.
Guided process
After creating a Snyk account, you can follow the optional getting-started walkthrough prompts to provide information and help Snyk guide your experience. This includes choosing an integration method, setting access permissions, configuring automation settings, and authenticating that integration.
Alternatively, if you want to scan your code without authenticating to your source code repository, you can select the CLI integration. This allows you to run scans from your local machine and upload results to your Organization in Snyk.
Manual process
You can add an integration to Snyk manually at any point from the Snyk Web UI. To do this, navigate to Integrations > Source Control. For more information, see Integrate with Snyk.
Obtain and use your Snyk API token
Before authenticating, be sure you have set your region properly. For details, see Regional hosting and data residency, which has the list of regional URLs.
Your Snyk API token is a personal token available under your user profile. The Snyk API token is associated with your Snyk Account and not with a specific Organization.
Free and Team plan and trial users have access only to this personal token under the user profile. The personal token can be used to authenticate with the Snyk CLI running on a local or a build machine and an IDE when you are setting a token manually. Use a personal token with caution if you are authenticating for CI/CD or with the API, which is available for Enterprise plan users only.
To obtain your personal Snyk API token:
Log in to Snyk and navigate to your personal account settings.
In your General settings, under API Token, select click to show.
Highlight and copy your API key.
If you want a new API token, select Revoke & Regenerate, but be aware that this will make the previous API token invalid.
For information on when to use an API token and when to use a service account token, available to Enterprise plan users only, see Authentication for API.
Import a Project to scan and identify issues
Snyk Projects are items that Snyk scans for issues, for example, a manifest file listing your open-source dependencies.
When you import a Project, Snyk scans that imported Project, and displays the results for you to review.
Importing a Project also does the following:
Sets Snyk to run a regular scan on that Project for issues. See Usage settings.
Initiates some automation, especially default Snyk tests on pull and merge requests, which help prevent vulnerabilities from being added to the Project. This automation fails builds according to your conditions and can be disabled or customized in your integration settings.
Set up Snyk Essentials
Snyk Essentials enables Application Security teams to implement, manage, and scale a modern, high-performing, developer security program. It covers use cases under Application Security Posture Management (ASPM).
For more information, see Snyk Essentials.
Review results and fix your issues
After you have imported a Project, and Snyk has scanned that Project for issues, you can view the results of your scan and take action to fix issues. You can see the number of issues found, grouped by severity level (Critical, High, Medium or Low). For details, see Severity levels.
The scan results and available actions depend on the type of Project you scan:
Open-source libraries: see Snyk Open Source.
Application code: see Snyk Code.
Container images: see Snyk Container.
Infrastructure as Code (IaC), Kubernetes, Helm and Terraform configuration files and cloud misconfigurations: see Snyk IaC.
Last updated
Was this helpful?