Skip to main content

Snyk

Visualize Snyk code repositories and findings, and monitor changes through queries and alerts.

Installation​

To use this integration, JupiterOne requires a Snyk API token with at minimum Org Viewer access to the Snyk organization you want to ingest. If you are integrating at the group level (to ingest multiple organizations), the token must have Group Viewer access to the Snyk group.

info

For more information on Snyk API authentication, refer to the Snyk authentication documentation.

Prerequisites​

  1. Snyk API token — Obtain your API token from Snyk:

    1. Click your profile avatar in the upper-right corner of the Snyk dashboard.
    2. Select Account Settings.
    3. Under General, click click to show next to Auth Token and copy the value.

  2. Organization ID or Group ID — Provide one of the following:

    • Organization ID — Found in Snyk under Settings > General for the organization. Required if ingesting a single organization.
    • Group ID — Found in Snyk under Group Settings > General. Required if ingesting all organizations within a group.

Configuration in JupiterOne​

To install the Snyk integration in JupiterOne, navigate to the Integrations tab and select Snyk. Click New Instance to begin configuring your integration, providing the following:

  • Account Name — A label used to identify this integration instance in JupiterOne. Ingested entities will have this value stored in tag.AccountName when the AccountName toggle is enabled.

  • Description — An optional description to help distinguish this instance from others.

  • Polling Interval — How often JupiterOne should collect data from Snyk. You may leave this as DISABLED and trigger the integration manually.

  • API Key — Your Snyk API token.

  • Organization ID or Group ID — Enter either your Organization ID (to ingest a single Snyk organization) or your Group ID (to ingest all organizations within a Snyk group). Exactly one of these is required.

Click Create after all values are provided.

Data Volume Configuration​

Data Filtering Options​

These optional settings control which findings are ingested. Reducing the scope can significantly lower the number of entities stored in JupiterOne.

FieldDescriptionDefaultOptions
Issue TypesThe types of issues to fetch. When nothing is selected, all issue types are fetched.AllPackage Vulnerabilities, License Issues, Cloud Configuration Issues, Code Quality Issues, Custom Issues, Configuration Issues
Severity LevelsThe severity levels of issues to fetch. When nothing is selected, all severity levels are fetched.AllCritical, High, Medium, Low
Include Resolved FindingsWhen enabled, resolved findings are included alongside open findings.Disabled—
Include Ignored FindingsWhen enabled, ignored findings are included alongside non-ignored findings.Disabled—

Next steps​

Once your integration instance is configured, it will begin running on the polling interval you selected. Continue on to our instance management guide to learn more about working with and editing integration instances.