Snyk Plugin

Automatically monitor your projects and deployed code for vulnerabilities and get updates on newly identified vulnerabilities.

To add a data source click on the + next to Data Sources on the left-hand menu in SquaredUp. Search for the data source and click on it to open the Configure data source page.

You can also add a data source by clicking Add data source on the Settings > Data Sources page, but pre-built dashboards are not added when using this method.

Before you start

When configuring the data source, you must enter a Snyk API key to authenticate the connection. For information on generating this API key, see the Snyk authentication for API documentation.

Configuring the data source

1. Display Name:
   Enter a name for your data source. This helps you to identify this data source in the list of your data sources.

2. API Key:
   Add the Snyk API key you generated. This is used to authenticate the plugin connection.
3. Index specific organizations:
   Select this check box if you wish to import specific Snyk organizations. The following fields display:
   1. Organization:
      Select this checkbox if you want to import a specific Snyk organization. Then, specify that Organization ID in the field that displays below.
   2. Group:
      Select this checkbox to import organizations and objects that belong to a specific Snyk group. Then, specify that Group ID in the field that displays below.

4. Restrict access to this data source:
   You can enable this option if you only want certain users or groups to have access to the data source, or the permission to link it to new workspaces. See data source access control for more information.

5. Click Test and add to validate the data source configuration. SquaredUp will now attempt to connect to SquaredUp using the provided authentication method.

   Testing outcomes

   • Testing passed – a success message will be displayed and then the configuration will be saved.
   • Testing passed with warnings – warnings will be listed and potential fixes suggested. You can still use the data source with warnings. Select Save with warnings if you believe that you can still use the data source as required with the warnings listed. Alternatively, address the issues listed and then select Rerun tests to validate the data source configuration again. If the validation now passes, click Save.
   • Testing Failed – errors will be listed and potential fixes suggested. You cannot use the data source with errors. You are able to select Save with errors if you believe that a system outside of SquaredUp is causing the error that you need to fix. Alternatively, address the issues listed and then select Rerun tests to validate the data source configuration again. If the validation now passes, click Save.

   You can edit any data source configurations at any time from Settings > Data Sources.

Next steps

After configuring the plugin, you can start using its data streams to create dashboards! You can also access the plugin's sample dashboards if you chose to install them.

Sample dashboards

The Key Metrics sample dashboard can be installed with this plugin. This dashboard displays an overview for the Snyk organizations you chose to import and includes visualizations for metrics such as the Total Issues, Time to Resolve Security Issues and a summary of your open security issues.

Data streams

Was this article helpful?