- 06 Nov 2024
- 2 Minutes to read
- Print
- DarkLight
- PDF
Snyk
- Updated on 06 Nov 2024
- 2 Minutes to read
- Print
- DarkLight
- PDF
Snyk is a developer security platform integrating directly into development tools, workflows, and automation pipelines.
Types of Assets Fetched
This adapter fetches the following types of assets:
- Devices
- Users
- Vulnerabilities
- SaaS Applications
- Application Development Exposures
- Application Resources
Parameters
Host Name or IP Address (required, default: https://api.snyk.io) - The hostname or IP address of the Snyk server.
API Token (required) - An API Token associated with a user account that has the permissions to fetch assets. Refer to Snyk API for information on how to obtain the API Key.
Group ID (optional) - Snyk Group ID. Either use a Group ID or an Organization ID. Using a group ID will fetch all users in the group (across all organizations).
Organzation ID (optional) - Snyk Organization ID. Either use a Group ID or an Organization ID. Using an organization ID will fetch all users in the organization.
If both are supplied, default to the group ID.
Verify SSL - Select whether to verify the SSL certificate of the server against the CA database inside of Axonius. For more details, see SSL Trust & CA Settings.
HTTPS Proxy (optional) - Connect the adapter to a proxy instead of directly connecting it to the domain.
HTTPS Proxy User Name (optional) - The user name to use when connecting to the value supplied in Host Name or IP Address via the value supplied in HTTPS Proxy.
HTTPS Proxy Password (optional) - The password to use when connecting to the server using the HTTPS Proxy.
To learn more about common adapter connection parameters and buttons, see Adding a New Adapter Connection.
Advanced Settings
Advanced settings can either apply for all connections for this adapter, or you can set different advanced settings and/or different scheduling for a specific connection, refer to Advanced Configuration for Adapters.
- Fetch Projects (Application Resources) - Select whether to fetch projects with their vulnerabilities or not. If you selected group ID on the main configuration screen, it will fetch all devices from all organizations in the group.
- Enrich organization name - Select this option to enrich the organization name in devices.
To learn more about Adapter Configuration tab advanced settings, see Adapter Advanced Settings.
APIs
Axonius uses the Snyk API.
You must have a Snyk Business or Enterprise plan to access the API. For more information, see Snyk API documentation.
Required Ports
Axonius must be able to communicate with the value supplied in Host Name or IP Address via the following ports:
- TCP port 443
Required Permissions
The value supplied in API Token must be associated with credentials that have Group Viewer (when using Group ID) permissions or Organization Collaborator (when using Org ID) permissions, in order to fetch assets.
In order to fetch devices View Project, View Project Snapshot permissions are required.
Version Matrix
This adapter was only tested with the versions marked as supported, but may work with other versions. Contact Axonius Support if you have a version that is not listed, which is not functioning as expected.
Version | Supported | Notes |
---|---|---|
Snyk API v1 | Yes | |
Snyk REST API (formerly known as Snyk API v3) | No | Snyk API |
Supported From Version
Supported from Axonius version 4.7