API endpoints index and notes

In addition to this index, this section provides scenarios for using Snyk APIs and pages with detailed information about using Snyk API endpoints.

For more information about using the Snyk API, see the following:

This list includes the categories and names of REST GA and beta and V1 API endpoints, with the URL in the reference docs for each endpoint, and links to related information where available. REST is the default, and GA is the status unless beta is noted. V1 API is specified where applicable. This listing is a work in progress; additional information is being added continually. For additional information, see Solutions for specific use cases and Scenarios for using Snyk API.

AccessRequests (beta)

Get access requests

Apps

More information: Snyk Apps

Get a list of apps that act on your behalf

Revoke an app

Get a list of active OAuth sessions for the app

Revoke an active user app session

Get a list of apps installed for a user

Revoke access for an app by install ID

Replaces: DEPRECATED Revoke app bot authorization

DEPRECATED Create a new app for an organization

Replaced by: Create a new Snyk App for an organization

More information: Create a Snyk App using the Snyk API

Get a list of apps created by an organization

Replaces: DEPRECATED Get a list of apps created by an organization

DEPRECATED Update app attributes that are name, redirect URIs, and access token time to live

Replaced by: Update app creation attributes such as name, redirect URIs, and access token time to live using the App ID

DEPRECATED Get an app by client id

Replaced by: Get a Snyk App by its App ID

DEPRECATED Delete an app

Replaced by: Delete an app by its App ID

DEPRECATED Manage client secrets for an app

Replaced by: Manage client secret for non-interactive Snyk App installations

Install a Snyk App to this organization

Get a list of apps installed for an organization

Replaces: DEPRECATED Get a list of app bots authorized to an organization

Revoke app authorization for a Snyk organization

See also: Revoke app authorization for a Snyk Group with install ID

Manage client secret for non-interactive Snyk App installations

Create a new Snyk App for an organization

Replaces: DEPRECATED Create a new app for an organization

DEPRECATED Get a list of apps created by an organization

Replaced by: Get a list of apps created by an organization

More information: Manage App details

Update app creation attributes such as name, redirect URIs, and access token time to live using the App ID

Replaces: DEPRECATED Update App attributes that are name, redirect URIs, and access token time to live

More information: Manage App details

Get a Snyk APP by its App ID

Replaces: DEPRECATED Get an app by client id

Delete a Snyk App by its App ID

Replaces: DEPRECATED Delete an app

More information: Manage App details

Manage client secret for the Snyk App

More information: Manage App details

DEPRECATED Get a list of app bots authorized to an organization

Replaced by: Get a list of apps installed for an organization

DEPRECATED Revoke app bot authorization

Replaced by: Revoke app authorization for a Snyk Group with install ID

Install a Snyk App to this group

Get a list of apps installed for a group

Revoke app authorization for a Snyk Group with install ID

Manage client secret for non-interactive Snyk App installations

Replaces: DEPRECATED Manage client secrets for an app

Audit Logs

Search Organization audit logs

More information: Retrieve audit logs of user-initiated activity by API for an Org or Group

Search Group audit logs

More information: Filter through your audit logs more efficiently with the new GA REST version of the audit logs API, and api.access is now opt-in

Retrieve audit logs of user-initiated activity by API for an Org or Group

Audit logs (v1)

Group level audit logs

Use Search Group audit logs

Organization level audit logs

Use Search Organization audit logs

Cloud (beta)

List Environments

Create New Environment

Delete Environment

Update Environment

Generate Cloud Provider Permissions

List Resources

List Scans

Create Scan

Get scan

Collection

Create a collection

Get collections

Edit a collection

Get a collection

Delete a collection

Add projects to a collection

Get projects from the specified collection

Remove projects from a collection

ContainerImage

List instances of container image

Get instance of container image

List instances of image target references for a container image

Custom Base Images

More information: Use Custom Base Image Recommendations

Create a Custom Base Image from an existing container project

More information: Use Custom Base Image Recommendations: Mark the created Project as a custom base image

Get a custom base image collection

Update a custom base image

Get a custom base image

Delete a custom base image

Dependencies (v1)

List all dependencies

Entitlements (v1)

List all entitlements

Get an organization's entitlement value

Groups (beta)

Get all groups

Get a group

More information: Org and group identification for Projects

Get all SSO connections for a group

Get all users using a given SSO connection

Delete a user from a Group SSO connection

More information: Remove members from Groups and Orgs using the API and Retrieve audit logs of user-initiated activity by API for an Org or Group.

Groups (v1)

List all tags in a group

Delete tag from group

Update group settings

View group settings

List all roles in a group

More information : Update member roles using the V1 API.

List all organizations in a group

More information: Org and group identification for Projects

Add a member to an organization within a group

List all members in a group

More information: Remove members from Groups and Orgs using the API.

IacSettings

Update the Infrastructure as Code Settings for an org

More information: Use a remote IaC custom rules bundle, Use a remote IaC custom rules bundle

Get the Infrastructure as Code Settings for a group

Update the Infrastructure as Code Settings for a group

More information: Use a remote IaC custom rules bundle, IaC custom rules within a pipeline, Use a remote IaC custom rules bundle

Get the Infrastructure as Code Settings for a group

Import Projects (v1)

Import targets

For information on when and how you can use this endpoint, see this page on importing targets.

If this fails, use Get import job details to help determine why. There are two types of failures:

The repository was rejected for processing, that is, HTTP status code 201 was not returned. This happens if there is an issue Snyk can see quickly for example:
- The repository does not exist.
- The repository is unreachable by Snyk because the token is invalid or does not have sufficient permissions; there is no default branch.
The repository was accepted for processing, that is, the user got back HTTP status code 201 and a url to poll, but no projects were detected or some failed. This may occur because:
- There are no Snyk-supported manifests in this repository.
- The repository is archived and the Snyk API calls to fetch files fail.
- The individual project or manifest had issues during processing. In this case Snyk returns success: false with a message in the log.

The poll results return a message per manifest processed, either success: true or success: false.

Get import job details

Integrations (v1)

Add new integration

List

Get existing integration by type

Update existing integration

Update

Retrieve

Clone an integration (with settings and credentials)

Delete credentials

Switch between broker tokens

Provision new broker token

Invites

Invite a user to an organization

List pending user invitation to an organization

Cancel a pending user invitations to an organization

Issues

List issues for a package

More information: Dart and Flutter, Rust

List issues for a given set of packages (Currently not available to all customers)

Get issues by org ID

Get an issue (Org)

Get issues by group ID

Note: Remedies are not included in the response.

More information: Reachability

Get an issue (Group)

Licenses (v1)

List all licenses

Monitor (v1)

Dep Graph

More information: Dep Graph API

Organizations (v1)

List all the organizations a user belongs to

More information: Org and group identification for Projects

Create a new organization

Remove organization

Update organization settings

View organization settings

Provision a user to the organization

More information: Provision users to Organizations using the V1 API.

List pending user provisions

Delete pending user provision

Set notification settings

Get organization notification settings

List members

More information: Update member roles using the V1 API and Remove members from Groups and Orgs using the API.

Update a member in the organization

Remove a member from the organization

More information: Remove members from Groups and Orgs using the API.

Update a member's roles in your organization

Invite users

More information: Update member roles using the V1 API.

Orgs (GA and beta)

List accessible organizations

Update organization

Get organization

List all organizations in a group

Get an ORG (beta)

More information: Org and group identification for Projects

Projects (v1)

More information: Project type responses from API

Update a project

Retrieve a single project

Delete a project

Add a tag to a project

Remove a tag from a project

Update project settings

List project settings

Delete project settings

Move project to a different organization

List all jira issues

List all project issue paths

More information: V1 API Project issue paths endpoints

Create jira issue

List all (project) ignores

Replace ignores

Add ignore

Retrieve ignore

Delete ignores

List all project snapshots

List all project snapshot issue paths

List all project snapshot aggregated issues

Get Project dependency graph

Deactivate (a project)

Applying (project) attributes

By using the Snyk API v1 endpoint Applying attributes you can set attributes for Snyk Projects including business criticality, lifecycle stage, and environment once the project has been created . To do so:

Import the project using the Snyk API v1 endpoint Import targets.
Get the status API ID from Import targets.
Poll using Import job details until all imports have completed.
Parse the project IDs from the projectURL field.
Use the Applying attributes endpoint to set the project attributes.

List all Aggregated (Project) issues

The Snyk V1 API endpoint List all aggregated issues returns an array of ignoreReasons for each vulnerability. This happens because ignores implemented using the CLI and API are path-based and thus potentially could have different ignoreReasons for different paths. Because List all aggregated issues returns only one issue for all paths, the entire set of reasons is returned. Snyk groups issues together by their identifier, so one response for the List all aggregated issues endpoint could correspond to the same issue across multiple paths. Thus the ignoredReason is across all issues that are aggregated and applies to that single grouped issue.

Activate (a project)

Projects

List all Projects for an Org with the given Org ID

The query-string parameter types is optional. The endpoint does not enforce specific project types and will return no matching projects if you enter a string that does not match a project type.

Updates project by project ID

Get project by project ID

Delete project by project ID

Pull request templates

Create or update pull request template for group

More information: Create and manage a custom PR template using the API.

Get pull request template for group

Delete pull request template for group

Reporting API (v1)

Get list of latest issues

To list all projects that have a vulnerability linked to a CVE use the capability to filter on strings with the Get list of latest issues and Get List of issues reporting endpoints. Filter by the identifier attribute.

To get a list of issues that have been fixed: Use Get list of latest issues and filter by “isFixed”: true in the request body. This endpoint also provides a list of all IaC issues.

Migrated Get list of latest issues

SBOM (GA and beta)

Get a project’s SBOM document

Create an SBOM test run (beta)

Gets an SBOM test run status (beta)

Gets an SBOM test run result (beta)

SastSettings

Enable/Disable the Snyk Code settings for an org

Retrieves the SAST settings for an org

ServiceAccounts

More information: Manage service accounts using the Snyk API; Choose a service account type to use with Snyk APIs