Snyk
App Vendor: Snyk
App Category: Vulnerability Management
Connector Version: 1.0.0
API Version: 1.0.0
About App
Snyk is a developer security platform that scans vulnerabilities in your code, open-source dependencies, containers, and code infrastructure.
The Snyk app is configured with Orchestrate to perform the following actions:
Action Name | Description |
|---|---|
Generate SBOM | This action generates SBOM for a project. |
Generic Action | This is a generic action to perform any additional use case on Snyk. |
Get all Organizations | This action retrieves a list of all organizations that the user is a part of from Snyk. |
Get all Projects | This action retrieves a list of all projects from Snyk. |
Get Project and its Details | This action retrieves a project and its details. |
Configuration Parameters
The following configuration parameters are required for the Snyk app to communicate with the Snyk enterprise application. The parameters can be configured by creating instances in the app.
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
API Token | Enter the API token to authenticate to snyk. | Password | Required |
|
Action: Generate SBOM
This action generates SBOM for a project.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
SBOM Format | Enter the SBOM format to generate. Example:
| Text | Required | |
Project ID | Enter the Snyk project ID. | Text | Required | |
Organization ID | Enter the Snyk organization ID. | Text | Required |
Action: Generic Action
This is a generic action to perform any additional use case on Snyk.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Endpoint | Enter the endpoint to perform the action. Example: /orgs/{orgid}/projects | Text | Required | |
Method | Enter the HTTP method to use. Example:
| Text | Required | |
Payload | Enter the payload of the request. Example: {"name": "organization-name"} | Key Value | Optional | |
Query Params | Enter the query parameters to filter results. Example: {"type": "auto"} | Key Value | Optional | P |
Action: Get all Organizations
This action retrieves a list of all organizations the user is a part of from Snyk.
Action Input Parameters
This action does not require any action input parameter.
Action: Get all Projects
This action retrieves a list of all projects from Snyk
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Organization ID | Enter the organization ID to retrieve all the projects in Snyk. | Text | Required |
|
Project Name | Enter the project name to filter results. Example: orchestrate | Text | Optional |
|
Type | Enter the type to filter projects. Example:
| Text | Optional |
|
Action: Get Project and its Details
This action retrieves the project and its details.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Organization ID | Enter the organization ID to get projects. | Text | Required |
|
Project ID | Enter the project ID to get the project details. | Text | Required |
|