Projects (v1)
Last updated
Last updated
More information
Snyk privacy policy© 2023 Snyk Limited | All product and company names and logos are trademarks of their respective owners.
View Organization
View Project
Remove Project
The organization ID the project belongs to. The API_KEY
must have access to this organization.
"4a18d42f-0706-4ad0-b127-24078731fbed"
The project ID.
"463c1ee5-31bc-428c-b451-b79a3270db08"
Deleting project settings will set the project to inherit default settings from its integration.
View Organization
View Project
Edit Project
The organization ID to which the project belongs. The API_KEY must have access to this organization.
"4a18d42f-0706-4ad0-b127-24078731fbed"
The project ID
"463c1ee5-31bc-428c-b451-b79a3270db08"
It is possible to modify/retrieve ignored vulnerability or license issues for a given organization and project.
Ignores from .snyk
files are not included here
View Organization
View Project Ignores
Remove Project Ignores
The organization ID to modify ignores for. The API_KEY
must have access to this organization.
"4a18d42f-0706-4ad0-b127-24078731fbed"
The project ID to modify ignores for.
"463c1ee5-31bc-428c-b451-b79a3270db08"
The issue ID to modify ignores for. Can be a vulnerability or a license Issue.
"npm:qs:20140806-1"
Deactivating a project will:
Disable pull request tests for new vulnerabilities.
Disable Fix pull request from being opened for newly disclosed vulnerabilities.
Disable recurring tests - email alerts about newly disclosed vulnerabilities will be turned off.
If the repository has no other active projects, then remove any webhooks related to the project.
View Organization
View Project
Project Status
The organization ID the project belongs to. The API_KEY
must have access to this organization.
"4a18d42f-0706-4ad0-b127-24078731fbed"
The project ID.
"463c1ee5-31bc-428c-b451-b79a3270db08"
Activating a project will:
Add a repository webhook for supported integrations.
Enable pull request tests for new vulnerabilities.
Open Fix pull request for newly disclosed vulnerabilities.
Enable recurring tests, sending email alerts about newly disclosed vulnerabilities.
View Organization
View Project
Project Status
The organization ID the project belongs to. The API_KEY
must have access to this organization.
"4a18d42f-0706-4ad0-b127-24078731fbed"
The project ID.
"463c1ee5-31bc-428c-b451-b79a3270db08"
Ignores from .snyk
files are not included here.
Ignores from Policies are not included here.Temporary ignores include an expires
attribute, while permanent ignores do not.
View Organization
View Project
View Project Ignores
The organization ID to list ignores for. The API_KEY
must have access to this organization.
"4a18d42f-0706-4ad0-b127-24078731fbed"
The project ID to list ignores for.
"463c1ee5-31bc-428c-b451-b79a3270db08"
The issue ID that should be ignored.
Note: when moving a project to a new organization, the historical data used for reporting does not move with it.
View Organization
View Project
Move Project
The organization ID to which the project belongs. The API_KEY must have group admin permissions. If the project is moved to a new group, a personal level API key is needed.
"4a18d42f-0706-4ad0-b127-24078731fbed"
The project ID.
"463c1ee5-31bc-428c-b451-b79a3270db08"
The ID of the organization that the project should be moved to. The API_KEY must have group admin permissions. If the project is moved to a new group, a personal level API key is needed.
If you have configured an integration with Jira, it is possible to create Jira issues for project vulnerabilities or license issues directly from the Snyk API.
The Jira integration is available to customers on the pro or enterprise plan.
At the moment, the usage of the Jira integration via the API is not supported for Snyk Infrastructure as Code
View Jira issues
The organization ID to list Jira issues for. The API_KEY
must have access to this organization.
"4a18d42f-0706-4ad0-b127-24078731fbed"
The project ID to list Jira issues for.
"463c1ee5-31bc-428c-b451-b79a3270db08"
The issue ID and relating jira issue.
View Project
View Project Snapshot
The organization ID. The API_KEY
must have access to this organization.
"4a18d42f-0706-4ad0-b127-24078731fbed"
The project ID for which to return issue paths.
"6d5813be-7e6d-4ab8-80c2-1e3e2a454545"
The issue ID for which to return issue paths.
"SNYK-JS-LODASH-590103"
The identifier of the snapshot for which the paths have been found
A list of the dependency paths that introduce the issue
The total number of results
The organization ID. The API_KEY
must have access to this organization.
"4a18d42f-0706-4ad0-b127-24078731fbed"
The project ID to remove a tag from
"6d5813be-7e6d-4ab8-80c2-1e3e2a454545"
Alphanumeric including - and _ with a limit of 30 characters
"example-tag-key"
Alphanumeric including - and _ with a limit of 50 characters
"example-tag-value"
Tags now applied to the project
If you have configured an integration with Jira, it is possible to create Jira issues for project vulnerabilities or license issues directly from the Snyk API.
The Jira integration is available to customers on the pro or enterprise plan.
At the moment, the usage of the Jira integration via the API is not supported for Snyk Infrastructure as Code
Create Jira issues
The organization ID to list Jira issues for. The API_KEY
must have access to this organization.
"4a18d42f-0706-4ad0-b127-24078731fbed"
The project ID to list Jira issues for.
"463c1ee5-31bc-428c-b451-b79a3270db08"
The issue ID to create Jira issue for.
"npm:qs:20140806-1"
The organization ID. The API_KEY
must have access to this organization.
"4a18d42f-0706-4ad0-b127-24078731fbed"
The project ID to apply the tag to
"6d5813be-7e6d-4ab8-80c2-1e3e2a454545"
Alphanumeric including - and _ with a limit of 30 characters
"example-tag-key"
Alphanumeric including - and _ with a limit of 50 characters
"example-tag-value"
Tags now applied to the project
View Organization
View Project
The organization ID to which the project belongs. The API_KEY must have access to this organization.
"4a18d42f-0706-4ad0-b127-24078731fbed"
The project ID
"463c1ee5-31bc-428c-b451-b79a3270db08"
The response will contain only attributes that can be updated (see ATTRIBUTES
section in Update project settings
) and that have been previously set.
If set to true
, Snyk will raise dependency upgrade PRs automatically.
An array of comma-separated strings with names of dependencies you wish Snyk to ignore to upgrade.
The age (in days) that an automatic dependency check is valid for
The limit on auto dependency upgrade PRs.
If set to true
, fail Snyk Test if the repo has any vulnerabilities. Otherwise, fail only when the PR is adding a vulnerable dependency.
If set to true
, fail Snyk Test only for high and critical severity vulnerabilities
If set to true
, Snyk Test checks PRs for vulnerabilities.:cq
assign Snyk pull requests
Defines automatic remediation policies
The response will contain only attributes that can be updated (see ATTRIBUTES
section in Update project settings
) and that have been previously set.
It is possible to modify/retrieve ignored vulnerability or license issues for a given organization and project.
Ignores from .snyk
files are not included here
View Organization
View Project Ignores
Create new project ignores
The organization ID to modify ignores for. The API_KEY
must have access to this organization.
"4a18d42f-0706-4ad0-b127-24078731fbed"
The project ID to modify ignores for.
"463c1ee5-31bc-428c-b451-b79a3270db08"
The issue ID to modify ignores for. Can be a vulnerability or a license Issue.
"npm:qs:20140806-1"
The path to ignore (default is *
which represents all paths).
The reason that the issue was ignored.
Only ignore the issue if no upgrade or patch is available.
The timestamp that the issue will no longer be ignored.
View Organization
View Project
View Project Snapshot
The organization ID. The API_KEY
must have access to this organization.
"4a18d42f-0706-4ad0-b127-24078731fbed"
The project ID for which to return issue paths.
"6d5813be-7e6d-4ab8-80c2-1e3e2a454545"
The project snapshot ID for which to return issue paths. If set to latest
, the most recent snapshot will be used. Use the "List all project snapshots" endpoint to find suitable values for this.
"6d5813be-7e6d-4ab8-80c2-1e3e2a454553"
The issue ID for which to return issue paths.
"SNYK-JS-LODASH-590103"
The identifier of the snapshot for which the paths have been found
A list of the dependency paths that introduce the issue
The total number of results
It is possible to modify/retrieve ignored vulnerability or license issues for a given organization and project.
Ignores from .snyk
files are not included here
View Organization
View Project Ignores
Edit Project Ignores
The organization ID to modify ignores for. The API_KEY
must have access to this organization.
"4a18d42f-0706-4ad0-b127-24078731fbed"
The project ID to modify ignores for.
"463c1ee5-31bc-428c-b451-b79a3270db08"
The issue ID to modify ignores for. Can be a vulnerability or a license Issue.
"npm:qs:20140806-1"
The path to ignore (default is *
which represents all paths).
The reason that the issue was ignored.
Only ignore the issue if no upgrade or patch is available.
The timestamp that the issue will no longer be ignored.
It is possible to modify/retrieve ignored vulnerability or license issues for a given organization and project.
Ignores from .snyk
files are not included here
View Project
View Project Ignores
The organization ID to modify ignores for. The API_KEY
must have access to this organization.
"4a18d42f-0706-4ad0-b127-24078731fbed"
The project ID to modify ignores for.
"463c1ee5-31bc-428c-b451-b79a3270db08"
The issue ID to modify ignores for. Can be a vulnerability or a license Issue.
"npm:qs:20140806-1"
View Organization
View Project
Edit Project
The organization ID to which the project belongs. The API_KEY must have access to this organization.
"4a18d42f-0706-4ad0-b127-24078731fbed"
The project ID
"463c1ee5-31bc-428c-b451-b79a3270db08"
If set to true
, Snyk will raise dependency upgrade PRs automatically.
An array of comma-separated strings with names of dependencies you wish Snyk to ignore to upgrade.
The age (in days) that an automatic dependency check is valid for
The limit on auto dependency upgrade PRs.
If set to true
, fail Snyk Test if the repo has any vulnerabilities. Otherwise, fail only when the PR is adding a vulnerable dependency.
If set to true
, fail Snyk Test only for high and critical severity vulnerabilities
If set to true
, Snyk Test checks PRs for vulnerabilities.:cq
assign Snyk pull requests
Defines automatic remediation policies
The response will contain the attributes and values that have been sent in the request and successfully updated.
If set to true
, Snyk will raise dependency upgrade PRs automatically.
An array of comma-separated strings with names of dependencies you wish Snyk to ignore to upgrade.
The age (in days) that an automatic dependency check is valid for
The limit on auto dependency upgrade PRs.
If set to true
, fail Snyk Test if the repo has any vulnerabilities. Otherwise, fail only when the PR is adding a vulnerable dependency.
If set to true
, fail Snyk Test only for high and critical severity vulnerabilities
If set to true
, Snyk Test checks PRs for vulnerabilities.:cq
assign Snyk pull requests
Defines automatic remediation policies
The response will contain the attributes and values that have been sent in the request and successfully updated.
Attributes are static and non-configurable fields which allow to add additional metadata to a project. Attributes have a pre-defined list of values that a user can select from.
Business criticality | Environment | Lifecycle stage |
---|---|---|
critical | frontend | production |
high | backend | development |
medium | internal | sandbox |
low | external | |
mobile | ||
saas | ||
onprem | ||
hosted | ||
distributed | ||
It is possible to assign multiple values to each attribute, but you can only assign values to one of the predefined attribute categories, using the predefined options for this category. | ||
Assigning an attribute requires the caller to be either an Organization Administrator or a Group Administrator. | ||
Assigning an attribute will override any existing values that the specific attribute already has set. | ||
In order to clear out an attribute value, an empty array can be set. |
Note: Organization admins can add an attribute to a Project. However, only Group admins can modify Project attributes in cases where attributes match a policy, because policies can only be managed by Group admins.
View Organization
View Project
Edit Project Attributes
The organization ID. The API_KEY
must have access to this organization.
"4a18d42f-0706-4ad0-b127-24078731fbed"
The project ID to remove a tag from
"6d5813be-7e6d-4ab8-80c2-1e3e2a454545"
View Project
View Project Snapshot
The organization ID. The API_KEY
must have access to this organization.
"4a18d42f-0706-4ad0-b127-24078731fbed"
The project ID to return issues for.
"6d5813be-7e6d-4ab8-80c2-1e3e2a454545"
If set to true
, Include issue's description, if set to false
(by default), it won't (Non-IaC projects only)
If set to true
, Include issue's introducedThrough, if set to false
(by default), it won't. It's for container only projects (Non-IaC projects only)
An array of identified issues
View Organization
View Project
Edit Project
The organization ID the project belongs to. The API_KEY
must have access to this organization.
"4a18d42f-0706-4ad0-b127-24078731fbed"
The project ID.
"463c1ee5-31bc-428c-b451-b79a3270db08"
The branch that this project should be monitoring
"main"
"snyk/goof"
The project identifier
"af137b96-6966-46c1-826b-2e79ac49bbd9"
The date that the project was created on
"2018-10-29T09:50:54.014Z"
The origin the project was added from
"github"
The package manager of the project
"maven"
Whether the project is read-only
false
The frequency of automated Snyk re-test. Can be 'daily', 'weekly or 'never'
"daily"
Number of dependencies of the project
42
For docker projects shows the ID of the image
"sha256:caf27325b298a6730837023a8a342699c8b7b388b8d878966b064a1320043019"
For docker projects shows the tag of the image
"latest"
For docker projects shows the base image
"alpine:3"
For docker projects shows the platform of the image
"linux/arm64"
For Kubernetes projects shows the origin cluster name
"Production"
The hostname for a CLI project, null if not set
The project remote repository url. Only set for projects imported via the Snyk CLI tool.
"https://github.com/snyk/goof.git"
The date on which the most recent test was conducted for this project
"2019-02-05T08:54:07.704Z"
The user who owns the project, null if not set
{ "id": "e713cf94-bb02-4ea0-89d9-613cce0caed2", "name": "example-user@snyk.io", "username": "exampleUser", "email": "example-user@snyk.io" }
URL with project overview
"https://app.snyk.io/org/4a18d42f-0706-4ad0-b127-24078731fbed/project/af137b96-6966-46c1-826b-2e79ac49bbd9"
Describes if a project is currently monitored or it is de-activated
The monitored branch (if available)
The identifier for which revision of the resource is scanned by Snyk. For example this may be a branch for SCM project, or a tag for a container image
List of applied tags
Applied project attributes
View Organization
View Project
View Project Snapshot
The organization ID the project belongs to. The API_KEY
must have access to this organization.
"4a18d42f-0706-4ad0-b127-24078731fbed"
The project ID.
"463c1ee5-31bc-428c-b451-b79a3270db08"
"snyk/goof"
The project identifier
"af137b96-6966-46c1-826b-2e79ac49bbd9"
The date that the project was created on
"2018-10-29T09:50:54.014Z"
The origin the project was added from
"github"
The package manager of the project
"maven"
Whether the project is read-only
false
The frequency of automated Snyk re-test. Can be 'daily', 'weekly or 'never'
"daily"
Number of dependencies of the project
42
For docker projects shows the ID of the image
"sha256:caf27325b298a6730837023a8a342699c8b7b388b8d878966b064a1320043019"
For docker projects shows the tag of the image
"latest"
For docker projects shows the base image
"alpine:3"
For docker projects shows the platform of the image
"linux/arm64"
For Kubernetes projects shows the origin cluster name
"Production"
The hostname for a CLI project, null if not set
The project remote repository url. Only set for projects imported via the Snyk CLI tool.
"https://github.com/snyk/goof.git"
The date on which the most recent test was conducted for this project
"2019-02-05T08:54:07.704Z"
The user who owns the project, null if not set
{ "id": "e713cf94-bb02-4ea0-89d9-613cce0caed2", "name": "example-user@snyk.io", "username": "exampleUser", "email": "example-user@snyk.io" }
URL with project overview
"https://app.snyk.io/org/4a18d42f-0706-4ad0-b127-24078731fbed/project/af137b96-6966-46c1-826b-2e79ac49bbd9"
Describes if a project is currently monitored or it is de-activated
The monitored branch (if available)
The identifier for which revision of the resource is scanned by Snyk. For example this may be a branch for SCM project, or a tag for a container image
List of applied tags
Applied project attributes
View Organization
View Project
View Project Snapshot
The organization ID. The API_KEY
must have access to this organization.
"4a18d42f-0706-4ad0-b127-24078731fbed"
The project ID to return issues for.
"6d5813be-7e6d-4ab8-80c2-1e3e2a454545"
A reference implementation of the graph, as well as conversion functions to/from legacy tree format, can be found at: https://github.com/snyk/dep-graph.
The object might contain additional fields in the future, in a backward-compatible way (schemaVersion
will change accordingly).
A reference implementation of the graph, as well as conversion functions to/from legacy tree format, can be found at: https://github.com/snyk/dep-graph.
The object might contain additional fields in the future, in a backward-compatible way (schemaVersion
will change accordingly).
View Organization
View Project
View Project Snapshot
The organization ID. The API_KEY
must have access to this organization.
"4a18d42f-0706-4ad0-b127-24078731fbed"
The project ID to return snapshots for.
"6d5813be-7e6d-4ab8-80c2-1e3e2a454545"
A list of the project's snapshots, ordered according to date (latest first).
The total number of results
View Organization
View Project
View Project Snapshot
The organization ID. The API_KEY
must have access to this organization.
"2d5c4d0c-c6d6-4658-a703-c2721c135b26"
The project ID.
"6d5813be-7e6d-4ab8-80c2-1e3e2a454545"
The snapshot ID. If set to latest, the most recent snapshot will be used.
"6d5813be-7e6d-4ab8-80c2-1e3e2a454553"
If set to true
, Include issue's description, if set to false
(by default), it won't (Non-IaC projects only)
If set to true
, Include issue's introducedThrough, if set to false
(by default), it won't. It's for container only projects (Non-IaC projects only)
An array of identified issues