Skip to main content
Snyk logo
  • Category: security & identity tools
  • Auth: OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 71
  • Triggers: 0
  • Slug: SNYK
  • Version: 20261101_00

Tools

Slug: SNYK_ADD_PROJECTS_TO_COLLECTIONAdd up to 100 projects to a Snyk collection. Warning: This may require collection product access or a qualifying account role.

Input Parameters

object
required
JSON:API data envelope containing the project identifiers to add.
string
required
ID of the Snyk organization that owns the collection.
string
required
ID of the collection to which to add projects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_BULK_DELETE_PROJECTSPermanently delete up to 100 Snyk projects, optionally excluding their target files from future scans; confirm the organization and project IDs first. A successful response may include per-project failures, so inspect both meta.deleted and meta.failed.

Input Parameters

object
required
Exact JSON:API bulk project deletion payload.
string
required
ID of the Snyk organization that owns the projects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_BULK_UPDATE_INVENTORY_ASSETSTransactionally update attributes for up to 100 inventory assets in a Snyk organization. This Early Access endpoint is beta and its contract may change; the connected account must have access to Snyk Inventory.

Input Parameters

object
required
Exact JSON:API bulk asset update payload.
string
required
ID of the Snyk organization containing the inventory assets.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_BULK_UPDATE_PROJECTSUpdate 1-20 distinct Snyk projects using individual patches or one shared patch, sending one request per project without rollback. Returns per-project outcomes when at least one succeeds, or a top-level error if all fail; a failed outcome can reflect an invalid response after an update.

Input Parameters

object
Shared typed patch applied to every project_id.
string
required
ID of the Snyk organization that owns the projects.
array
One to 20 project IDs with individual typed patches.
array
One to 20 project IDs that receive the shared patch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_CREATE_COLLECTIONCreate a collection in a Snyk organization. This operation may require collection product access or a qualifying account role; the build account returned 403 with the documented collection scopes granted.

Input Parameters

object
required
JSON:API request payload for the new collection.
string
required
ID of the Snyk organization in which to create the collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_CREATE_EXPORTStart an asynchronous organization export, returning an export ID and polling link when available. Reporting/export product access or a qualifying role may be required.

Input Parameters

object
required
JSON:API request payload that configures the export.
string
required
ID of the Snyk organization whose data should be exported.
string
Snyk export option controlling inclusion of deleted issues.
string
Snyk export option controlling inclusion of disabled issues.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_CREATE_IGNORE_POLICYCreate an organization-level ignore policy for a specific Snyk Code finding. This API requires Code Consistent Ignores to be enabled.

Input Parameters

object
required
Exact JSON:API payload for the new ignore policy.
string
required
ID of the Snyk organization in which to create the policy.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_CREATE_REPOSITORY_ALIASESLink one or more alternate repository URLs to canonical repository assets in a Snyk organization. Warning: Snyk marks this endpoint as beta and its contract may change.

Input Parameters

string
required
ID of the Snyk organization in which to create repository aliases.
array
required
Canonical and alternate repository URL pairs to link (1-100 items).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_CREATE_SBOM_TESTStart asynchronous vulnerability analysis of a CycloneDX 1.4-1.6 JSON or SPDX 2.3 JSON SBOM. Returns the job ID and polling URL for the SBOM test status and result actions. Components without supported PackageURLs are skipped. Warning: Snyk marks this endpoint as beta and its contract may change.

Input Parameters

object
required
Complete CycloneDX 1.4-1.6 JSON or SPDX 2.3 JSON document to test. Components need supported PackageURLs for vulnerability analysis.
string ("cyclonedx1.4+json" | "cyclonedx1.5+json" | "cyclonedx1.6+json" | "spdx2.3+json")
Optional format of the supplied SBOM document.
string
required
ID of the Snyk organization in which to run the SBOM test.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_DELETE_COLLECTIONPermanently delete a Snyk collection. This destructive operation cannot be undone; confirm the organization and collection IDs before calling. May require collection product access or a qualifying account role.

Input Parameters

string
required
ID of the Snyk organization that owns the collection.
string
required
ID of the collection to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_DELETE_IGNORE_POLICYPermanently delete an organization-level Snyk ignore policy. This destructive operation cannot be undone; confirm the organization and policy IDs before calling. Organization-level policy APIs require Code Consistent Ignores.

Input Parameters

string
required
ID of the Snyk organization that owns the ignore policy.
string
required
ID of the ignore policy to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_DELETE_PROJECTPermanently delete one Snyk project from an organization. This destructive operation cannot be undone; confirm the organization and project IDs before calling.

Input Parameters

string
required
ID of the Snyk organization that owns the project.
string
required
ID of the project to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_DELETE_REPOSITORY_ALIASESDetach 1-100 aliased URLs from their canonical repository assets in a Snyk organization. Each detached URL becomes a standalone asset. This destructive Early Access operation cannot be undone; confirm every asset ID and URL pair before calling. Snyk marks this endpoint beta and its contract may change.

Input Parameters

string
required
ID of the Snyk organization containing the repository assets.
array
required
Repository asset IDs and URL pairs to detach (1-100 items).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_DELETE_TARGETPermanently delete a Snyk target and all projects associated with it. This destructive cascade cannot be undone; confirm the organization and target IDs before calling.

Input Parameters

string
required
ID of the Snyk organization that owns the target.
string
required
ID of the target to permanently delete. Deleting the target also deletes all projects associated with it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_DOWNLOAD_FINDINGS_DOCUMENTDownload a completed findings document of up to 100 MiB and return an offloaded file reference. The endpoint is beta and its contract may change.

Input Parameters

string
required
ID of the Snyk organization that owns the findings document.
string
required
ID of an existing completed findings document obtained outside this toolkit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_DOWNLOAD_PROJECT_SBOMDownload a Snyk project’s software bill of materials as CycloneDX JSON/XML or SPDX JSON and return an offloaded file reference.

Input Parameters

string ("cyclonedx1.6+json" | "cyclonedx1.6+xml" | "cyclonedx1.5+json" | "cyclonedx1.5+xml" | "cyclonedx1.4+json" | "cyclonedx1.4+xml" | "spdx2.3+json")
SBOM document format. Supports CycloneDX 1.4, 1.5, and 1.6 as JSON or XML, and SPDX 2.3 as JSON.
string
required
Unique ID of the Snyk organization that owns the project.
array
Features to omit from the generated SBOM. Currently only licenses can be excluded.
string
required
Unique ID of the Snyk project whose SBOM to download.
boolean
Consolidate Go package-level dependencies into module-level components. This option applies only to gomodules dependency graphs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_GET_COLLECTIONRetrieve a collection from a Snyk organization. The connected account must have collection product access or a qualifying organization role.

Input Parameters

string
required
ID of the Snyk organization that owns the collection.
string
required
Unique ID of the collection to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_GET_CONTAINER_IMAGERetrieve a container image by its SHA-256 digest from a Snyk organization.

Input Parameters

string
required
ID of the Snyk organization that owns the container image.
string
required
SHA-256 digest that uniquely identifies the container image.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_GET_EXPORTRetrieve completed export results from a Snyk organization. This endpoint may require reporting/export product access or a qualifying organization role.

Input Parameters

string
required
ID of the Snyk organization that owns the export.
string
required
Unique ID of the export whose results to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_GET_EXPORT_JOB_STATUSGet the current status of a Snyk organization export job. The connected account may need reporting or export product access or a qualifying role.

Input Parameters

string
required
ID of the Snyk organization that owns the export job.
string
required
Unique export ID returned when the export was started.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_GET_IAC_SETTINGSRetrieve Infrastructure as Code settings for a Snyk organization. This may require Snyk IaC product access or a qualifying account role.

Input Parameters

string
required
ID of the Snyk organization whose Infrastructure as Code settings to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_GET_IGNORE_POLICYRetrieve an organization-level ignore policy by ID. This API is available only for Snyk Code Consistent Ignores.

Input Parameters

string
required
ID of the Snyk organization that owns the ignore policy.
string
required
ID of the organization-level ignore policy to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_GET_INVENTORY_ASSETRetrieve one inventory asset by ID from a Snyk organization, optionally using sparse fieldsets. This Early Access endpoint is beta, may change, and requires Snyk Inventory access.

Input Parameters

object
Sparse fieldsets keyed by JSON:API asset type: container_images, sboms, or repositories. Each value is a comma-separated field list; type and id are always returned.
string
required
ID of the Snyk organization that owns the inventory asset.
string
required
Unique ID of the inventory asset to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_GET_INVENTORY_ASSET_SEARCH_RESULTSRetrieve one page of results from a previously started asynchronous Snyk inventory asset search. Supply a search ID created outside this toolkit because the search-start endpoint is not exposed. This Early Access endpoint is beta, may change, and requires Snyk Inventory access.

Input Parameters

string
Comma-separated fields by which to sort results; prefix a field with - for descending order.
integer
Maximum number of matching assets to return on this page (10-100).
string
Continuation cursor returned by a previous call; omit for the first page.
object
Sparse fieldsets keyed by JSON:API asset type: container_images, sboms, or repositories. Each value is a comma-separated field list; type and id are always returned.
string
required
ID of the Snyk organization in which the asset search was started.
string
required
ID of the asynchronous inventory asset search whose results to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_GET_OPEN_SOURCE_BROKER_SETTINGRetrieve whether the Open Source Broker setting is enabled for a Snyk organization.

Input Parameters

string
required
ID of the Snyk organization whose Open Source Broker setting to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_GET_OPEN_SOURCE_ECOSYSTEM_BROKER_SETTINGSRetrieve Broker settings for the Dotnet or Golang Open Source ecosystem in a Snyk organization. Ecosystem identifiers are case-sensitive.

Input Parameters

string
required
Snyk organization ID whose Open Source ecosystem Broker settings to retrieve.
string ("Dotnet" | "Golang")
required
Case-sensitive Open Source ecosystem identifier: Dotnet or Golang.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_GET_OPEN_SOURCE_PRIVATE_REGISTRY_SETTINGSRetrieve publicly accessible private registry settings for the Dotnet or Golang Open Source ecosystem in a Snyk organization. These registries are reached directly with credentials rather than through Snyk Broker.

Input Parameters

string
required
Snyk organization ID whose Open Source private registry settings to retrieve.
string ("Dotnet" | "Golang")
required
Case-sensitive Open Source ecosystem identifier whose private registry settings to retrieve: Dotnet or Golang.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_GET_ORGANIZATIONRetrieve the full details of a Snyk organization. Optionally expand the organization’s tenant relationship.

Input Parameters

array
Related resources whose attributes should be included in the response.
string
required
Unique ID of the Snyk organization to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_GET_ORGANIZATION_ISSUERetrieve one Snyk issue by its organization and issue IDs, optionally including data flows for Snyk Code issues.

Input Parameters

string
required
ID of the Snyk organization that owns the issue.
string
required
Unique ID of the issue to retrieve.
boolean
Whether to include data-flow details for Snyk Code issues. Data flows must also be enabled for the organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_GET_PACKAGE_TESTRetrieve a Snyk package test by ID, including its execution state, outcome, component facts, and finding summaries. The findings themselves are available through the returned findings link. This toolkit does not provide the package-test create/poll workflow, so supply an existing test ID. Warning: Snyk marks this endpoint as beta and its contract may change.

Input Parameters

string
required
ID of the Snyk organization that owns the package test.
string
required
ID of an existing Snyk package test obtained outside this toolkit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_GET_PROJECTRetrieve a Snyk project by ID, including its settings and relationships. Optionally expand the target and include metadata from the latest scan.

Input Parameters

array
Set to target to include attributes for the project’s target relationship.
string
required
ID of the Snyk organization that owns the project.
string
required
Unique ID of the project to retrieve.
boolean
Include severity counts from the project’s most recent scan.
boolean
Include the dependency total from the project’s most recent scan.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_GET_SAST_SETTINGSRetrieve the SAST settings for a Snyk organization.

Input Parameters

string
required
ID of the Snyk organization whose SAST settings to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_GET_SBOM_TEST_RESULTRetrieve one page of affected packages from a finished Snyk SBOM test, together with the test result resource. Poll Get SBOM Test Status first and call this action after the job finishes. Warning: Snyk marks this endpoint as beta and its contract may change.

Input Parameters

integer
Number of affected packages to return on this page (10-100, in multiples of 10).
string
Continuation cursor returned by a previous call; omit for the first page.
string
required
Job ID of a finished SBOM test.
string
required
ID of the Snyk organization that owns the SBOM test job.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_GET_SBOM_TEST_STATUSPoll the status of an asynchronous Snyk SBOM test job. When the status is finished, use Get SBOM Test Result with the same job ID. Warning: Snyk marks this endpoint as beta and its contract may change.

Input Parameters

string
required
Job ID returned when the SBOM test was started.
string
required
ID of the Snyk organization that owns the SBOM test job.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_GET_TARGETRetrieve a target by ID from a Snyk organization.

Input Parameters

string
required
ID of the Snyk organization that owns the target.
string
required
Unique ID of the target to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_LIST_BROKER_CONNECTIONSList one page of Broker connections integrated with a Snyk organization.

Input Parameters

integer
Number of Broker connections to return on this page (1-100).
string
Continuation cursor returned by a previous call; omit for the first page.
string
required
Snyk organization ID whose Broker connections to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_LIST_COLLECTION_PROJECTSList one page of projects in a Snyk collection, with issue counts and owning targets. May require collection product access or a qualifying account role.

Input Parameters

array
Projects to include: vuln-groups selects projects with issues and clean-groups selects projects without issues; pass both for both groups.
string ("imported" | "last_tested_at" | "issues")
Project attribute by which to sort the results.
integer
Number of projects to return on this page (10-100, in multiples of 10).
string
Continuation cursor returned by a previous call; omit for the first page.
string
required
ID of the Snyk organization that owns the collection.
string ("ASC" | "DESC")
Direction in which to sort the projects; Snyk defaults to DESC.
array
Target IDs whose projects to include (maximum 25).
array
Snyk integration types whose projects to include. Accepted values: acr, api, artifactory-cr, aws-lambda, azure-functions, azure-repos, bitbucket-cloud, bitbucket-connect-app, bitbucket-server, cli, cloud-foundry, digitalocean-cr, docker-hub, ecr, gcr, github-cr, github-enterprise, github, gitlab-cr, gitlab, google-artifact-cr, harbor-cr, heroku, ibm-cloud, kubernetes, nexus-cr, pivotal, quay-cr, and terraform-cloud.
string
required
Unique ID of the collection whose projects to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_LIST_COLLECTIONSList one page of a Snyk organization’s collections, including project and issue counts. May require collection product access or a qualifying account role.

Input Parameters

string
Return collections whose names contain this string.
string ("name" | "projectsCount" | "issues")
Attribute by which to sort collections.
integer
Number of collections to return on this page (10-100, in multiples of 10).
string
Continuation cursor returned by a previous call; omit for the first page.
string
required
Snyk organization ID whose collections to list.
string ("ASC" | "DESC")
Direction in which to sort collections.
boolean
Filter collections by whether Snyk generated them automatically.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_LIST_COMPONENT_FINDINGSList one page of unsuppressed findings for a component in a completed Snyk package test. The organization, test, and component IDs select the findings; use the returned cursor to continue in finding-ID order. Supply existing test and component IDs because this toolkit does not provide the package-test create/poll workflow. Warning: Snyk marks this endpoint as beta and its contract may change.

Input Parameters

integer
Number of findings to return on this page (10-100, in multiples of 10).
string
Continuation cursor returned by a previous call; omit for the first page.
string
required
ID of the Snyk organization that owns the package test.
string
required
ID of an existing completed package test obtained outside this toolkit.
string
required
ID of the component within the test whose findings to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_LIST_CONTAINER_IMAGESList one page of container images in a Snyk organization, optionally filtered by image digest, platform, or registry name.

Input Parameters

integer
Number of container images to return on this page (10-100, in multiples of 10).
array
Return images with these container registry names.
string
Continuation cursor returned by a previous call; omit for the first page.
string
required
Snyk organization ID whose container images to list.
string ("aix/ppc64" | "android/386" | "android/amd64" | "android/arm" | "android/arm/v5" | "android/arm/v6" | "android/arm/v7" | "android/arm64" | "android/arm64/v8" | "darwin/amd64" | "darwin/arm" | "darwin/arm/v5" | "darwin/arm/v6" | "darwin/arm/v7" | "darwin/arm64" | "darwin/arm64/v8" | "dragonfly/amd64" | "freebsd/386" | "freebsd/amd64" | "freebsd/arm" | "freebsd/arm/v5" | "freebsd/arm/v6" | "freebsd/arm/v7" | "illumos/amd64" | "ios/arm64" | "ios/arm64/v8" | "js/wasm" | "linux/386" | "linux/amd64" | "linux/arm" | "linux/arm/v5" | "linux/arm/v6" | "linux/arm/v7" | "linux/arm64" | "linux/arm64/v8" | "linux/loong64" | "linux/mips" | "linux/mipsle" | "linux/mips64" | "linux/mips64le" | "linux/ppc64" | "linux/ppc64le" | "linux/riscv64" | "linux/s390x" | "linux/x86_64" | "netbsd/386" | "netbsd/amd64" | "netbsd/arm" | "netbsd/arm/v5" | "netbsd/arm/v6" | "netbsd/arm/v7" | "openbsd/386" | "openbsd/amd64" | "openbsd/arm" | "openbsd/arm/v5" | "openbsd/arm/v6" | "openbsd/arm/v7" | "openbsd/arm64" | "openbsd/arm64/v8" | "plan9/386" | "plan9/amd64" | "plan9/arm" | "plan9/arm/v5" | "plan9/arm/v6" | "plan9/arm/v7" | "solaris/amd64" | "windows/386" | "windows/amd64" | "windows/arm" | "windows/arm/v5" | "windows/arm/v6" | "windows/arm/v7" | "windows/arm64" | "windows/arm64/v8")
Return images for this operating-system and processor-architecture platform.
array
Return only images with these SHA-256 image digest IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_LIST_CONTAINER_IMAGE_TARGET_REFSList one page of target references associated with a container image in a Snyk organization.

Input Parameters

integer
Number of target references to return on this page (10-100, in multiples of 10).
string
Continuation cursor returned by a previous call; omit for the first page.
string
required
ID of the Snyk organization that owns the container image.
string
required
SHA-256 digest that uniquely identifies the container image.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_LIST_IGNORE_POLICIESList one page of organization-level Snyk Code Consistent Ignore policies, with optional search, review, expiry, and sorting filters.

Input Parameters

integer
Number of policies to return on this page (10-100, in multiples of 10).
string
Continuation cursor returned by a previous call; omit for the first page.
string
required
ID of the Snyk organization whose ignore policies to list.
array
Review states by which to filter policies: pending, approved, rejected, or not-required.
Search ignored-user names and emails or ignore types in policy rules.
string ("created" | "expires" | "ignore-type" | "requested-by")
Policy field by which to sort the results.
string
Return only policies that expire strictly after this RFC 3339 timestamp.
boolean
Return only policies that never expire when true.
string
Return only policies that expire strictly before this RFC 3339 timestamp.
string ("asc" | "desc")
Direction in which to sort the policies.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_LIST_IGNORE_POLICY_EVENTSList one page of event history for a Snyk organization ignore policy. Warning: this beta API requires Code Consistent Ignores and the ignore approval workflow feature.

Input Parameters

integer
Number of policy events to return on this page (10-100, in multiples of 10).
string
Continuation cursor returned by a previous call; omit for the first page.
string
required
ID of the Snyk organization that owns the ignore policy.
string
required
ID of the ignore policy whose event history to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_LIST_INVENTORY_ASSET_PROJECTSList one page of Snyk projects linked to an inventory asset, including project attributes and issue counts. This Early Access beta endpoint may require inventory product access or a qualifying account role.

Input Parameters

string ("snapshot_created_at" | "-snapshot_created_at" | "issues" | "-issues")
Sort projects by snapshot_created_at or issues; prefix the field with ’-’ for descending order. Defaults to snapshot_created_at ascending.
integer
Number of linked projects to return on this page (10-100, in multiples of 10).
string
Continuation cursor returned by a previous call; omit for the first page.
string
required
Unique ID of the Snyk organization that owns the inventory asset.
string
required
Unique ID of the inventory asset whose linked projects to list.
string ("with" | "only" | "none")
Filter projects by canonical status: ‘with’ returns all projects and populates is_canonical, ‘only’ returns canonical projects, and ‘none’ returns non-canonical projects.
string
Return only projects that belong to this target ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_LIST_INVENTORY_ASSETSList one page of a Snyk organization’s inventory assets, with optional RSQL filtering, sorting, sparse fieldsets, and total count. This Early Access endpoint is beta, may change, and requires Snyk inventory product access.

Input Parameters

string
Comma-separated fields by which to sort assets; prefix a field with - for descending order.
integer
Number of inventory assets to return on this page (10-100, in multiples of 10).
string
Continuation cursor returned by a previous call; omit for the first page.
object
Sparse fieldsets keyed by JSON:API asset type. Each value is a comma-separated field list; type and id are always returned.
string
RSQL expression used to filter assets. Supports comparison operators, =in=/=out= lists, ; for AND, , for OR, and * wildcards with == or !=.
string
required
Snyk organization ID whose inventory assets to list.
string ("with" | "only")
Use with to include the total matching asset count with data, or only to return the count without asset data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_LIST_INVENTORY_ASSET_TARGETSList one page of Snyk targets linked to an inventory asset, with target attributes such as origin, reference, manifest file, integration, and import time when available. This Early Access beta endpoint may require inventory product access or a qualifying account role.

Input Parameters

integer
Number of linked targets to return on this page (10-100, in multiples of 10).
string
Continuation cursor returned by a previous call; omit for the first page.
string
required
Unique ID of the Snyk organization that owns the inventory asset.
string
required
Unique ID of the inventory asset whose linked targets to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_LIST_INVENTORY_FILTER_FIELDSList one page of fields available for filtering a Snyk organization’s inventory assets with RSQL. This Early Access endpoint is beta and its contract may change.

Input Parameters

integer
Number of inventory filter fields to return on this page (10-100, in multiples of 10).
string
Continuation cursor returned by a previous call; omit for the first page.
string
required
Snyk organization ID whose inventory filter fields to list.
array
Inventory asset types whose available filter fields to return: container_images, sboms, or repositories. Values are sent as a comma-separated query parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_LIST_INVENTORY_FILTER_VALUESList one page of distinct values for a Snyk inventory filter field for autocomplete. This inventory endpoint is in beta.

Input Parameters

string
Return object-filter values associated with this key.
integer
Number of filter values to return on this page (10-100, in multiples of 10).
string
Search the available values; with keys_only this searches object keys, and with key it searches values for that key.
string
Continuation cursor returned by a previous call; omit for the first page.
string
required
ID of the Snyk organization whose inventory filter values to list.
string
required
ID of a filter field returned by the inventory filter fields endpoint.
boolean
Return only object-filter keys when true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_LIST_INVENTORY_GROUP_FIELDSList one page of fields available for grouping inventory assets in a Snyk organization, optionally filtered by asset type. This Early Access beta capability may require additional Snyk product access.

Input Parameters

integer
Number of grouping fields to return on this page (10-100, in multiples of 10).
string
Continuation cursor returned by a previous call; omit for the first page.
string
required
Snyk organization ID whose available inventory grouping fields to list.
array
Inventory asset types for which to return grouping fields: container_images, sboms, or repositories. Values are sent as a comma-separated query parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_LIST_INVENTORY_GROUP_VALUESList one page of aggregated values for a Snyk inventory group field. This Early Access capability may require inventory product access or a qualifying account role.

Input Parameters

string
Comma-separated fields used to sort group values; prefix a field with ’-’ for descending order. Supported fields are value, count, created_at, last_seen_at, updated_at, risk_score, built_at, and issues.
integer
Number of group values to return on this page (10-100, in multiples of 10).
string
Continuation cursor returned by a previous call; omit for the first page.
string
RSQL expression that filters the assets included in the aggregation.
string
required
Unique ID of the Snyk organization whose inventory to query.
object
Per-metadata-field aggregation overrides. Fields default to ‘last’; supported functions are max, min, first, last, and sum.
string
Comma-separated asset types to include in the aggregation.
array
Aggregated metadata to include: count, created_at, last_seen_at, updated_at, risk_score, issues, labels, tags, or built_at. Use all for every available field. Requesting metadata can increase response time.
string
required
Group-field ID returned by the inventory group-fields endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_LIST_ISSUES_FOR_PACKAGEList one offset page of direct vulnerabilities for a versioned Package URL. Transitive vulnerabilities are not included. Pass the returned opaque cursor unchanged to continue; Maven checksum qualifiers also return match metadata.

Input Parameters

string
required
Unencoded, versioned Package URL to inspect. The tool safely encodes it as one path segment. Supported package types are apk, cargo, cocoapods, composer, conan, deb, gem, generic, golang, hex, maven, npm, nuget, pub, pypi, rpm, and swift. Maven purls may include one checksum qualifier.
integer
Maximum number of direct vulnerabilities to return in this page (1-1000).
string
Opaque continuation cursor returned by a previous call. Pass it back unchanged to retrieve the next offset page; omit it for the first page.
string
required
Unique ID of the Snyk organization in which to inspect the package.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_LIST_ISSUES_FOR_PACKAGESList direct vulnerabilities for a batch of versioned Package URLs. Snyk restricts this endpoint and does not make it available to all customers; availability depends on the connected account’s product entitlement. Transitive vulnerabilities are not included.

Input Parameters

object
required
Exact Snyk batch payload: data.attributes.purls contains versioned Package URLs; data.type is optional.
string
required
Unique ID of the Snyk organization in which to inspect packages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_LIST_LANGUAGE_SETTINGSGet one page of language and package-manager settings for a Snyk organization. This beta Early Access contract is deprecated and marked for sunset; use it only while the pinned API version remains available.

Input Parameters

integer
Number of results to return on this page (10-100, in multiples of 10).
string
Continuation cursor returned by a previous call; omit for the first page.
string
required
ID of the Snyk organization whose language settings to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_LIST_ORGANIZATION_ISSUESList one page of issues for a Snyk organization, with filters for scan item, issue type, timestamps, effective severity, status, ignored state, and Code data flows.

Input Parameters

string ("package_vulnerability" | "license" | "cloud" | "code" | "custom" | "config" | "secrets")
Return only issues of this issue type.
integer
Number of issues to return on this page (10-100, in multiples of 10).
string
Continuation cursor returned by a previous call; omit for the first page.
string
required
ID of the Snyk organization whose issues to list.
array
Issue statuses by which to filter issues: open or resolved.
boolean
Return ignored issues when true or non-ignored issues when false.
string
Return only issues related to this scan item ID.
string
Return only issues created after this RFC 3339 timestamp.
string
Return only issues updated after this RFC 3339 timestamp.
string
Return only issues created before this RFC 3339 timestamp.
string ("project" | "environment")
Return only issues related to this type of scan item.
string
Return only issues updated before this RFC 3339 timestamp.
boolean
Include data-flow details for Snyk Code issues when true.
array
Effective severity levels by which to filter issues: info, low, medium, high, or critical.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_LIST_ORGANIZATIONSList one page of Snyk organizations accessible to the connected account, with group, personal-organization, slug, name, and relationship-expansion filters.

Input Parameters

string
Return only organizations whose display name contains this value.
string
Return only organizations whose URL-friendly slug exactly matches this value.
integer
Number of organizations to return on this page (10-100, in multiples of 10).
string
Continuation cursor returned by a previous call; omit for the first page.
array
Related resources to expand with attributes. The only accepted value is member_role.
string
Return only organizations in this Snyk group.
boolean
When true, return only personal organizations that are not part of a group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_LIST_PROJECTSList one page of a Snyk organization’s projects. Filter by target, identity, name, origin, type, CLI monitoring time, importing user, tags, or project classifications, and optionally include target and latest-scan metadata.

Input Parameters

array
Return projects matching any of these project IDs.
array
Return projects matching all key:value tags.
integer
Number of projects to return on this page (10-100, in multiples of 10).
array
Return projects matching any of these exact names.
array
Return projects using any of these package-manager or project types.
string
Continuation cursor returned by a previous call; omit for the first page.
array
Relationships to expand. The only accepted value is target, which expands each project’s target relationship.
string
required
ID of the Snyk organization whose projects to list.
array
Return projects imported from any of these origins, such as github or cli.
array
Return projects matching all selected lifecycle values: production, development, or sandbox.
array
Return projects belonging to any of these target IDs.
string
Set to the only accepted value, only, to return the total matching project count without project data.
array
Return projects matching all selected environment values: frontend, backend, internal, external, mobile, saas, onprem, hosted, or distributed.
string
Return projects whose scanned target file or path matches this value.
string
Return projects whose target runtime matches this value.
array
Return projects whose names start with any of these prefixes.
string
Return projects whose scanned target revision matches this reference.
string
Return CLI projects uploaded and monitored after this timestamp.
boolean
Include severity counts from each project’s most recent scan.
array
Return projects matching all selected business-criticality values: critical, high, medium, or low.
string
Return CLI projects uploaded and monitored before this timestamp.
boolean
Include the dependency total from each project’s most recent scan.
array
Return projects imported by any of these user public IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_LIST_TARGETSList one page of a Snyk organization’s targets. Filter by privacy, project presence, remote URL, integration source type, display-name prefix, or creation time, and optionally include the total matching count.

Input Parameters

string
Return targets whose remote URL exactly matches this value.
boolean
Calculate and return the total number of targets matching the filters.
integer
Number of targets to return on this page (1-100).
string
Continuation cursor returned by a previous call; omit for the first page.
string
required
ID of the Snyk organization whose targets to list.
boolean
Return targets matching this private or publicly accessible status.
string
Return targets created at or after this timestamp.
string
Return targets whose display names start with this string.
array
Return targets matching any integration source type. Accepted values: bitbucket-server, gitlab, github-enterprise, bitbucket-cloud, bitbucket-connect-app, azure-repos, github, github-cloud-app, github-server-app, cli, docker-hub, in-memory-fs, acr, ecr, gcr, artifactory-cr, harbor-cr, quay-cr, github-cr, nexus-cr, nexus-private-repo, digitalocean-cr, gitlab-cr, google-artifact-cr, heroku, kubernetes, api, aws-lambda, azure-functions, cloud-foundry, pivotal, ibm-cloud, and terraform-cloud.
boolean
When true, return only targets that contain projects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_LIST_TEST_FINDINGSList one page of non-threshold-violating, policy-unsuppressed findings from a Snyk package test. Findings are scanner-independent vulnerability and policy-breach records sorted by ID. Supply an existing completed test ID because this toolkit does not provide the package-test create/poll workflow. Warning: Snyk marks this endpoint as beta and its contract may change.

Input Parameters

integer
Number of findings to return on this page (1-100).
string
Continuation cursor returned by a previous call; omit for the first page.
string
required
ID of the Snyk organization that owns the package test.
string
required
ID of an existing completed Snyk package test obtained outside this toolkit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_LOOKUP_INVENTORY_ASSETLook up one inventory asset in a Snyk organization by natural key or alias. A natural-key match takes precedence over an alias match. This Early Access endpoint is beta, may change, and requires Snyk Inventory access.

Input Parameters

string
required
Natural key or alias to resolve. Snyk prefers a natural-key match when an alias matches a different asset.
string ("container_images" | "sboms" | "repositories")
required
JSON:API asset type to search within: repositories, container_images, or sboms.
object
Sparse fieldsets keyed by JSON:API asset type: container_images, sboms, or repositories. Each value is a comma-separated field list; type and id are always returned.
string
required
Unique ID of the Snyk organization containing the inventory asset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_REMOVE_PROJECTS_FROM_COLLECTIONRemove up to 100 projects from a Snyk collection. Warning: This may require collection product access or a qualifying account role.

Input Parameters

object
required
JSON:API data envelope containing the project identifiers to remove.
string
required
ID of the Snyk organization that owns the collection.
string
required
ID of the collection from which to remove projects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_UPDATE_COLLECTIONRename a Snyk collection. This may require collection product access or a qualifying account role.

Input Parameters

object
required
Exact JSON:API payload for the collection update.
string
required
ID of the Snyk organization that owns the collection.
string
required
ID of the collection to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_UPDATE_IAC_SETTINGSUpdate Infrastructure as Code custom-rule inheritance, enablement, or OCI registry URL and tag for a Snyk organization. This may require Snyk IaC product access or a qualifying organization role.

Input Parameters

object
required
Exact JSON:API payload for the Infrastructure as Code settings update.
string
required
ID of the Snyk organization whose Infrastructure as Code settings to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_UPDATE_IGNORE_POLICYUpdate an organization-level ignore policy. This API is available only when Snyk Code Consistent Ignores is enabled.

Input Parameters

object
required
Exact JSON:API payload for the policy update.
string
required
ID of the Snyk organization that owns the policy.
string
required
ID of the policy to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_UPDATE_INVENTORY_ASSETPartially update the classification, labels, or tags of one Snyk inventory asset. This Early Access endpoint is beta and its contract may change; the connected account must have access to Snyk Inventory.

Input Parameters

object
required
Exact JSON:API asset update payload.
string
required
ID of the Snyk organization containing the inventory asset.
string
required
ID of the inventory asset to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_UPDATE_LANGUAGE_SETTINGSUpdate package-manager settings for one programming language in a Snyk organization. Warning: Snyk marks this beta contract as deprecated or sunset; use it only while the pinned version remains served.

Input Parameters

object
required
Exact JSON:API payload for the language-settings update.
string
required
ID of the Snyk organization whose language settings are updated.
string ("javascript" | "python" | "dotnet" | "php" | "golang" | "java")
required
Programming language whose package-manager settings are updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_UPDATE_OPEN_SOURCE_ECOSYSTEM_BROKER_SETTINGSUpdate selected Broker integrations for a specific Open Source ecosystem in a Snyk organization. Only provided integrations are changed; omitting an integration’s URLs or providing an empty list removes that integration.

Input Parameters

object
required
Exact JSON:API payload for the ecosystem Broker settings update.
string
required
ID of the Snyk organization whose ecosystem Broker settings are updated.
string
required
Case-sensitive Open Source ecosystem identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_UPDATE_OPEN_SOURCE_PRIVATE_REGISTRY_SETTINGSAdd, update, or remove private registry integrations for one Open Source ecosystem in a Snyk organization. The endpoint uses patch semantics, so unlisted integrations remain unchanged.

Input Parameters

object
required
Exact JSON:API payload containing the private registry changes.
string
required
ID of the Snyk organization whose private registry settings to update.
string
required
Case-sensitive Open Source ecosystem identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_UPDATE_ORGANIZATIONUpdate the display name of a Snyk organization.

Input Parameters

object
required
Exact JSON:API payload for the organization update.
string
required
ID of the Snyk organization to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_UPDATE_ORG_SECRETS_SETTINGSEnable or disable Secrets for a Snyk organization. This Early Access contract is beta, may change, and availability depends on product enablement.

Input Parameters

object
required
Exact JSON:API payload for the Secrets settings update.
string
required
ID of the Snyk organization whose Secrets settings are updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_UPDATE_PROJECTUpdate a Snyk project’s classifications, tags, test frequency, or owner.

Input Parameters

object
required
Exact JSON:API payload for the project update.
array
Set to target to expand the updated project’s target relationship.
string
required
ID of the Snyk organization that owns the project.
string
required
ID of the project to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SNYK_UPDATE_SAST_SETTINGSEnable or disable Snyk Code SAST for an organization.

Input Parameters

object
required
Exact JSON:API payload for the SAST settings update.
string
required
ID of the Snyk organization whose SAST settings are updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not