API endpoints index and notes

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)

Apps

More information: Snyk Apps

Replaces: DEPRECATED Revoke app bot authorization

Replaced by: Create a new Snyk App for an organization

More information: Create a Snyk App using the Snyk API

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

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

Replaced by: Get a Snyk App by its App ID

DEPRECATED Delete an app

Replaced by: Delete an app by its App ID

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

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

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

Replaces: DEPRECATED Create a new app for an organization

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

More information: Manage App details

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

More information: Manage App details

Replaces: DEPRECATED Get an app by client id

Replaces: DEPRECATED Delete an app

More information: Manage App details

More information: Manage App details

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

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

See also: Revoke access for an app by install

Replaces: DEPRECATED Manage client secrets for an app

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

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

Audit logs (v1)

Group level audit logs

To find who created an Org-level or Group-level service account, use API v1 Get group level audit logs or Get organization level audit logs to find the event that shows service account creation, deletion, or edit.

Migrated Get group level audit logs

Organization level audit logs

To find who created an Org-level or Group-level service account, use API v1 Get group level audit logs or and Get organization level audit logs to find the event that shows service account creation, deletion, or edit.

Migrated Get organization level audit logs

Cloud (beta)

Collection

ContainerImage

Custom Base Images

More information: Use Custom Base Image Recommendations

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

Dependencies (v1)

Dependencies by organization

List all dependencies

Migrated List all dependencies

Entitlements (v1)

Entitlements by organization

List all entitlements

Migrated list all entitlements

A specific entitlement by organization

Get an organization's entitlement value

Migrated Get an organization's entitlement value

Groups (beta)

More information: Org and group identification for Projects

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)

Group settings

View group settings

Migrated View group settings

Update group settings

Migrated Update group settings

List members in a group

List all members in a group

Migrated List all members in a group

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

Members in an organization of a group

Add a member to an organization within a group

Migrated Add a member to an organization within a group

List all tags in a group

List all tags in a group

Migrated List all tags in a group