---
canonical_url: "https://docs.composio.dev/toolkits/snyk"
markdown_url: "https://docs.composio.dev/toolkits/snyk.md"
product: "platform"
version: null
last_updated: null
---

# Snyk

Snyk helps development teams find, prioritize, and remediate security issues across code, dependencies, containers, and cloud infrastructure.

- **Category:** security & identity tools
- **Auth:** OAUTH2
- **Composio-managed OAuth available?** No
- **Tools:** 71
- **Triggers:** 0
- **Slug:** `SNYK`
- **Version:** 00000000_00

## Tools

### Add Projects To Collection

**Slug:** `SNYK_ADD_PROJECTS_TO_COLLECTION`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON:API data envelope containing the project identifiers to add. |
| `org_id` | string | Yes | ID of the Snyk organization that owns the collection. |
| `collection_id` | string | Yes | ID of the collection to which to add projects. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Bulk Delete Projects

**Slug:** `SNYK_BULK_DELETE_PROJECTS`

Permanently delete up to 100 Snyk projects. This is destructive and cannot be undone; confirm the organization and every project ID before calling. A 200 response may include per-project failures, so inspect both meta.deleted and meta.failed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Exact JSON:API bulk project deletion payload. |
| `org_id` | string | Yes | ID of the Snyk organization that owns the projects. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Bulk Update Inventory Assets

**Slug:** `SNYK_BULK_UPDATE_INVENTORY_ASSETS`

Transactionally 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Exact JSON:API bulk asset update payload. |
| `org_id` | string | Yes | ID of the Snyk organization containing the inventory assets. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Bulk Update Projects

**Slug:** `SNYK_BULK_UPDATE_PROJECTS`

Update 1-20 distinct Snyk projects using individual typed patches or one shared patch. Sends one request per project, does not roll back successful updates, and returns an explicit outcome for every project when at least one succeeds. If every update fails, the action returns a top-level error to prevent a no-op from being reported as successful.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `patch` | object | No | Shared typed patch applied to every project_id. |
| `org_id` | string | Yes | ID of the Snyk organization that owns the projects. |
| `updates` | array | No | One to 20 project IDs with individual typed patches. |
| `project_ids` | array | No | One to 20 project IDs that receive the shared patch. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Collection

**Slug:** `SNYK_CREATE_COLLECTION`

Create 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON:API request payload for the new collection. |
| `org_id` | string | Yes | ID of the Snyk organization in which to create the collection. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Export

**Slug:** `SNYK_CREATE_EXPORT`

Start an asynchronous organization export and return the export ID and polling link. Use Get Export Job Status before retrieving the results. This operation may require reporting/export product access or a qualifying role; the build account returned 403 with org.report.read granted.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON:API request payload that configures the export. |
| `org_id` | string | Yes | ID of the Snyk organization whose data should be exported. |
| `include_deleted` | string | No | Snyk export option controlling inclusion of deleted issues. |
| `include_deactivated` | string | No | Snyk export option controlling inclusion of disabled issues. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Ignore Policy

**Slug:** `SNYK_CREATE_IGNORE_POLICY`

Create an organization-level ignore policy for a specific Snyk Code finding. This API requires Code Consistent Ignores to be enabled.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Exact JSON:API payload for the new ignore policy. |
| `org_id` | string | Yes | ID of the Snyk organization in which to create the policy. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Repository Aliases

**Slug:** `SNYK_CREATE_REPOSITORY_ALIASES`

Link 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | ID of the Snyk organization in which to create repository aliases. |
| `aliases` | array | Yes | Canonical and alternate repository URL pairs to link (1-100 items). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create SBOM Test

**Slug:** `SNYK_CREATE_SBOM_TEST`

Start 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Collection

**Slug:** `SNYK_DELETE_COLLECTION`

Permanently 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | ID of the Snyk organization that owns the collection. |
| `collection_id` | string | Yes | ID of the collection to permanently delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Ignore Policy

**Slug:** `SNYK_DELETE_IGNORE_POLICY`

Permanently 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | ID of the Snyk organization that owns the ignore policy. |
| `policy_id` | string | Yes | ID of the ignore policy to permanently delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Project

**Slug:** `SNYK_DELETE_PROJECT`

Permanently delete one Snyk project from an organization. This destructive operation cannot be undone; confirm the organization and project IDs before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | ID of the Snyk organization that owns the project. |
| `project_id` | string | Yes | ID of the project to permanently delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Repository Aliases

**Slug:** `SNYK_DELETE_REPOSITORY_ALIASES`

Detach 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | ID of the Snyk organization containing the repository assets. |
| `aliases` | array | Yes | Repository asset IDs and URL pairs to detach (1-100 items). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Target

**Slug:** `SNYK_DELETE_TARGET`

Permanently 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | ID of the Snyk organization that owns the target. |
| `target_id` | string | Yes | ID of the target to permanently delete. Deleting the target also deletes all projects associated with it. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Findings Document

**Slug:** `SNYK_DOWNLOAD_FINDINGS_DOCUMENT`

Download the raw bytes of a completed findings document and return an offloaded file reference. Supply an existing completed document ID because this toolkit does not provide the findings-document create/poll workflow. Warning: Snyk marks this endpoint beta and its contract may change.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | ID of the Snyk organization that owns the findings document. |
| `document_id` | string | Yes | ID of an existing completed findings document obtained outside this toolkit. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Project SBOM

**Slug:** `SNYK_DOWNLOAD_PROJECT_SBOM`

Download a Snyk project's software bill of materials as CycloneDX JSON/XML or SPDX JSON and return an offloaded file reference.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Collection

**Slug:** `SNYK_GET_COLLECTION`

Retrieve a collection from a Snyk organization. The connected account must have collection product access or a qualifying organization role.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | ID of the Snyk organization that owns the collection. |
| `collection_id` | string | Yes | Unique ID of the collection to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Container Image

**Slug:** `SNYK_GET_CONTAINER_IMAGE`

Retrieve a container image by its SHA-256 digest from a Snyk organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | ID of the Snyk organization that owns the container image. |
| `image_id` | string | Yes | SHA-256 digest that uniquely identifies the container image. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Export

**Slug:** `SNYK_GET_EXPORT`

Retrieve completed export results from a Snyk organization. This endpoint may require reporting/export product access or a qualifying organization role.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | ID of the Snyk organization that owns the export. |
| `export_id` | string | Yes | Unique ID of the export whose results to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Export Job Status

**Slug:** `SNYK_GET_EXPORT_JOB_STATUS`

Get 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | ID of the Snyk organization that owns the export job. |
| `export_id` | string | Yes | Unique export ID returned when the export was started. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get IAC Settings

**Slug:** `SNYK_GET_IAC_SETTINGS`

Retrieve Infrastructure as Code settings for a Snyk organization. This may require Snyk IaC product access or a qualifying account role.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | ID of the Snyk organization whose Infrastructure as Code settings to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Ignore Policy

**Slug:** `SNYK_GET_IGNORE_POLICY`

Retrieve an organization-level ignore policy by ID. This API is available only for Snyk Code Consistent Ignores.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | ID of the Snyk organization that owns the ignore policy. |
| `policy_id` | string | Yes | ID of the organization-level ignore policy to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Inventory Asset

**Slug:** `SNYK_GET_INVENTORY_ASSET`

Retrieve 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | object | No | 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. |
| `org_id` | string | Yes | ID of the Snyk organization that owns the inventory asset. |
| `asset_id` | string | Yes | Unique ID of the inventory asset to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Inventory Asset Search Results

**Slug:** `SNYK_GET_INVENTORY_ASSET_SEARCH_RESULTS`

Retrieve 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Comma-separated fields by which to sort results; prefix a field with - for descending order. |
| `limit` | integer | No | Maximum number of matching assets to return on this page (10-100). |
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `fields` | object | No | 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. |
| `org_id` | string | Yes | ID of the Snyk organization in which the asset search was started. |
| `search_id` | string | Yes | ID of the asynchronous inventory asset search whose results to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Open Source Broker Setting

**Slug:** `SNYK_GET_OPEN_SOURCE_BROKER_SETTING`

Retrieve whether the Open Source Broker setting is enabled for a Snyk organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | ID of the Snyk organization whose Open Source Broker setting to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Open Source Ecosystem Broker Settings

**Slug:** `SNYK_GET_OPEN_SOURCE_ECOSYSTEM_BROKER_SETTINGS`

Retrieve all Broker settings for a specific Open Source ecosystem in a Snyk organization. Ecosystem identifiers are case-sensitive.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | Snyk organization ID whose Open Source ecosystem Broker settings to retrieve. |
| `ecosystem` | string ("Dotnet" | "Golang") | Yes | Case-sensitive Open Source ecosystem identifier: Dotnet or Golang. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Open Source Private Registry Settings

**Slug:** `SNYK_GET_OPEN_SOURCE_PRIVATE_REGISTRY_SETTINGS`

Retrieve publicly accessible private registry settings for a specific Open Source ecosystem in a Snyk organization. These registries are reached directly with credentials rather than through Snyk Broker.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | Snyk organization ID whose Open Source private registry settings to retrieve. |
| `ecosystem` | string ("Dotnet" | "Golang") | Yes | Case-sensitive Open Source ecosystem identifier whose private registry settings to retrieve: Dotnet or Golang. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Organization

**Slug:** `SNYK_GET_ORGANIZATION`

Retrieve the full details of a Snyk organization. Optionally expand the organization's tenant relationship.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expand` | array | No | Related resources whose attributes should be included in the response. |
| `org_id` | string | Yes | Unique ID of the Snyk organization to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Organization Issue

**Slug:** `SNYK_GET_ORGANIZATION_ISSUE`

Retrieve one Snyk issue by its organization and issue IDs, optionally including data flows for Snyk Code issues.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | ID of the Snyk organization that owns the issue. |
| `issue_id` | string | Yes | Unique ID of the issue to retrieve. |
| `include_code_flows` | boolean | No | Whether to include data-flow details for Snyk Code issues. Data flows must also be enabled for the organization. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Package Test

**Slug:** `SNYK_GET_PACKAGE_TEST`

Retrieve 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | ID of the Snyk organization that owns the package test. |
| `test_id` | string | Yes | ID of an existing Snyk package test obtained outside this toolkit. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Project

**Slug:** `SNYK_GET_PROJECT`

Retrieve a Snyk project by ID, including its settings and relationships. Optionally expand the target and include metadata from the latest scan.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expand` | array | No | Set to target to include attributes for the project's target relationship. |
| `org_id` | string | Yes | ID of the Snyk organization that owns the project. |
| `project_id` | string | Yes | Unique ID of the project to retrieve. |
| `latest_issue_counts` | boolean | No | Include severity counts from the project's most recent scan. |
| `latest_dependency_total` | boolean | No | Include the dependency total from the project's most recent scan. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SAST Settings

**Slug:** `SNYK_GET_SAST_SETTINGS`

Retrieve the SAST settings for a Snyk organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | ID of the Snyk organization whose SAST settings to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SBOM Test Result

**Slug:** `SNYK_GET_SBOM_TEST_RESULT`

Retrieve 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of affected packages to return on this page (10-100, in multiples of 10). |
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `job_id` | string | Yes | Job ID of a finished SBOM test. |
| `org_id` | string | Yes | ID of the Snyk organization that owns the SBOM test job. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SBOM Test Status

**Slug:** `SNYK_GET_SBOM_TEST_STATUS`

Poll 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | string | Yes | Job ID returned when the SBOM test was started. |
| `org_id` | string | Yes | ID of the Snyk organization that owns the SBOM test job. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Target

**Slug:** `SNYK_GET_TARGET`

Retrieve a target by ID from a Snyk organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | ID of the Snyk organization that owns the target. |
| `target_id` | string | Yes | Unique ID of the target to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Broker Connections

**Slug:** `SNYK_LIST_BROKER_CONNECTIONS`

List one page of Broker connections integrated with a Snyk organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of Broker connections to return on this page (1-100). |
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `org_id` | string | Yes | Snyk organization ID whose Broker connections to list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Collection Projects

**Slug:** `SNYK_LIST_COLLECTION_PROJECTS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `show` | array | No | Projects to include: vuln-groups selects projects with issues and clean-groups selects projects without issues; pass both for both groups. |
| `sort` | string ("imported" | "last_tested_at" | "issues") | No | Project attribute by which to sort the results. |
| `limit` | integer | No | Number of projects to return on this page (10-100, in multiples of 10). |
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `org_id` | string | Yes | ID of the Snyk organization that owns the collection. |
| `direction` | string ("ASC" | "DESC") | No | Direction in which to sort the projects; Snyk defaults to DESC. |
| `target_id` | array | No | Target IDs whose projects to include (maximum 25). |
| `integration` | array | No | 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. |
| `collection_id` | string | Yes | Unique ID of the collection whose projects to list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Collections

**Slug:** `SNYK_LIST_COLLECTIONS`

List 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Component Findings

**Slug:** `SNYK_LIST_COMPONENT_FINDINGS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of findings to return on this page (10-100, in multiples of 10). |
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `org_id` | string | Yes | ID of the Snyk organization that owns the package test. |
| `test_id` | string | Yes | ID of an existing completed package test obtained outside this toolkit. |
| `component_id` | string | Yes | ID of the component within the test whose findings to list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Container Images

**Slug:** `SNYK_LIST_CONTAINER_IMAGES`

List one page of container images in a Snyk organization, optionally filtered by image digest, platform, or registry name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of container images to return on this page (10-100, in multiples of 10). |
| `names` | array | No | Return images with these container registry names. |
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `org_id` | string | Yes | Snyk organization ID whose container images to list. |
| `platform` | 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") | No | Return images for this operating-system and processor-architecture platform. |
| `image_ids` | array | No | Return only images with these SHA-256 image digest IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Container Image Target Refs

**Slug:** `SNYK_LIST_CONTAINER_IMAGE_TARGET_REFS`

List one page of target references associated with a container image in a Snyk organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of target references to return on this page (10-100, in multiples of 10). |
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `org_id` | string | Yes | ID of the Snyk organization that owns the container image. |
| `image_id` | string | Yes | SHA-256 digest that uniquely identifies the container image. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Ignore Policies

**Slug:** `SNYK_LIST_IGNORE_POLICIES`

List one page of organization-level Snyk Code Consistent Ignore policies, with optional search, review, expiry, and sorting filters.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Ignore Policy Events

**Slug:** `SNYK_LIST_IGNORE_POLICY_EVENTS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of policy events to return on this page (10-100, in multiples of 10). |
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `org_id` | string | Yes | ID of the Snyk organization that owns the ignore policy. |
| `policy_id` | string | Yes | ID of the ignore policy whose event history to list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Inventory Asset Projects

**Slug:** `SNYK_LIST_INVENTORY_ASSET_PROJECTS`

List 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Inventory Assets

**Slug:** `SNYK_LIST_INVENTORY_ASSETS`

List 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Inventory Asset Targets

**Slug:** `SNYK_LIST_INVENTORY_ASSET_TARGETS`

List one page of Snyk targets linked to an inventory asset, including each target's origin, reference, manifest file, integration, and import time. This Early Access beta endpoint may require inventory product access or a qualifying account role.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of linked targets to return on this page (10-100, in multiples of 10). |
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `org_id` | string | Yes | Unique ID of the Snyk organization that owns the inventory asset. |
| `asset_id` | string | Yes | Unique ID of the inventory asset whose linked targets to list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Inventory Filter Fields

**Slug:** `SNYK_LIST_INVENTORY_FILTER_FIELDS`

List 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Inventory Filter Values

**Slug:** `SNYK_LIST_INVENTORY_FILTER_VALUES`

List one page of distinct values for a Snyk inventory filter field for autocomplete. This inventory endpoint is in beta.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Inventory Group Fields

**Slug:** `SNYK_LIST_INVENTORY_GROUP_FIELDS`

List 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Inventory Group Values

**Slug:** `SNYK_LIST_INVENTORY_GROUP_VALUES`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | 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. |
| `limit` | integer | No | Number of group values to return on this page (10-100, in multiples of 10). |
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `filter` | string | No | RSQL expression that filters the assets included in the aggregation. |
| `org_id` | string | Yes | Unique ID of the Snyk organization whose inventory to query. |
| `aggregate` | object | No | Per-metadata-field aggregation overrides. Fields default to 'last'; supported functions are max, min, first, last, and sum. |
| `asset_types` | string | No | Comma-separated asset types to include in the aggregation. |
| `meta_fields` | array | No | 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. |
| `group_field_id` | string | Yes | Group-field ID returned by the inventory group-fields endpoint. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Issues For Package

**Slug:** `SNYK_LIST_ISSUES_FOR_PACKAGE`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `purl` | string | Yes | 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. |
| `limit` | integer | No | Maximum number of direct vulnerabilities to return in this page (1-1000). |
| `cursor` | string | No | Opaque continuation cursor returned by a previous call. Pass it back unchanged to retrieve the next offset page; omit it for the first page. |
| `org_id` | string | Yes | Unique ID of the Snyk organization in which to inspect the package. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Issues For Packages

**Slug:** `SNYK_LIST_ISSUES_FOR_PACKAGES`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Exact Snyk batch payload: data.attributes.purls contains versioned Package URLs; data.type is optional. |
| `org_id` | string | Yes | Unique ID of the Snyk organization in which to inspect packages. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Language Settings

**Slug:** `SNYK_LIST_LANGUAGE_SETTINGS`

Get 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return on this page (10-100, in multiples of 10). |
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `org_id` | string | Yes | ID of the Snyk organization whose language settings to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Organization Issues

**Slug:** `SNYK_LIST_ORGANIZATION_ISSUES`

List 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Organizations

**Slug:** `SNYK_LIST_ORGANIZATIONS`

List one page of Snyk organizations accessible to the connected account, with group, personal-organization, slug, name, and relationship-expansion filters.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Projects

**Slug:** `SNYK_LIST_PROJECTS`

List 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Targets

**Slug:** `SNYK_LIST_TARGETS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | Return targets whose remote URL exactly matches this value. |
| `count` | boolean | No | Calculate and return the total number of targets matching the filters. |
| `limit` | integer | No | Number of targets to return on this page (1-100). |
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `org_id` | string | Yes | ID of the Snyk organization whose targets to list. |
| `is_private` | boolean | No | Return targets matching this private or publicly accessible status. |
| `created_gte` | string | No | Return targets created at or after this timestamp. |
| `display_name` | string | No | Return targets whose display names start with this string. |
| `source_types` | array | No | 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. |
| `exclude_empty` | boolean | No | When true, return only targets that contain projects. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Test Findings

**Slug:** `SNYK_LIST_TEST_FINDINGS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of findings to return on this page (1-100). |
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `org_id` | string | Yes | ID of the Snyk organization that owns the package test. |
| `test_id` | string | Yes | ID of an existing completed Snyk package test obtained outside this toolkit. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Lookup Inventory Asset

**Slug:** `SNYK_LOOKUP_INVENTORY_ASSET`

Look 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `key` | string | Yes | Natural key or alias to resolve. Snyk prefers a natural-key match when an alias matches a different asset. |
| `type` | string ("container_images" | "sboms" | "repositories") | Yes | JSON:API asset type to search within: repositories, container_images, or sboms. |
| `fields` | object | No | 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. |
| `org_id` | string | Yes | Unique ID of the Snyk organization containing the inventory asset. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Projects From Collection

**Slug:** `SNYK_REMOVE_PROJECTS_FROM_COLLECTION`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON:API data envelope containing the project identifiers to remove. |
| `org_id` | string | Yes | ID of the Snyk organization that owns the collection. |
| `collection_id` | string | Yes | ID of the collection from which to remove projects. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Collection

**Slug:** `SNYK_UPDATE_COLLECTION`

Rename a Snyk collection. This may require collection product access or a qualifying account role.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Exact JSON:API payload for the collection update. |
| `org_id` | string | Yes | ID of the Snyk organization that owns the collection. |
| `collection_id` | string | Yes | ID of the collection to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update IAC Settings

**Slug:** `SNYK_UPDATE_IAC_SETTINGS`

Update 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Exact JSON:API payload for the Infrastructure as Code settings update. |
| `org_id` | string | Yes | ID of the Snyk organization whose Infrastructure as Code settings to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Ignore Policy

**Slug:** `SNYK_UPDATE_IGNORE_POLICY`

Update an organization-level ignore policy. This API is available only when Snyk Code Consistent Ignores is enabled.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Exact JSON:API payload for the policy update. |
| `org_id` | string | Yes | ID of the Snyk organization that owns the policy. |
| `policy_id` | string | Yes | ID of the policy to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Inventory Asset

**Slug:** `SNYK_UPDATE_INVENTORY_ASSET`

Partially 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Exact JSON:API asset update payload. |
| `org_id` | string | Yes | ID of the Snyk organization containing the inventory asset. |
| `asset_id` | string | Yes | ID of the inventory asset to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Language Settings

**Slug:** `SNYK_UPDATE_LANGUAGE_SETTINGS`

Update 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Exact JSON:API payload for the language-settings update. |
| `org_id` | string | Yes | ID of the Snyk organization whose language settings are updated. |
| `language` | string ("javascript" | "python" | "dotnet" | "php" | "golang" | "java") | Yes | Programming language whose package-manager settings are updated. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Open Source Ecosystem Broker Settings

**Slug:** `SNYK_UPDATE_OPEN_SOURCE_ECOSYSTEM_BROKER_SETTINGS`

Update 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Exact JSON:API payload for the ecosystem Broker settings update. |
| `org_id` | string | Yes | ID of the Snyk organization whose ecosystem Broker settings are updated. |
| `ecosystem` | string | Yes | Case-sensitive Open Source ecosystem identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Open Source Private Registry Settings

**Slug:** `SNYK_UPDATE_OPEN_SOURCE_PRIVATE_REGISTRY_SETTINGS`

Add, 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Exact JSON:API payload containing the private registry changes. |
| `org_id` | string | Yes | ID of the Snyk organization whose private registry settings to update. |
| `ecosystem` | string | Yes | Case-sensitive Open Source ecosystem identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Organization

**Slug:** `SNYK_UPDATE_ORGANIZATION`

Update the display name of a Snyk organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Exact JSON:API payload for the organization update. |
| `org_id` | string | Yes | ID of the Snyk organization to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Org Secrets Settings

**Slug:** `SNYK_UPDATE_ORG_SECRETS_SETTINGS`

Update the Early Access Secrets settings for a Snyk organization. Availability depends on product enablement; Snyk marks this contract beta and it may change.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Exact JSON:API payload for the Secrets settings update. |
| `org_id` | string | Yes | ID of the Snyk organization whose Secrets settings are updated. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Project

**Slug:** `SNYK_UPDATE_PROJECT`

Update a Snyk project's classifications, tags, test frequency, or owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Exact JSON:API payload for the project update. |
| `expand` | array | No | Set to target to expand the updated project's target relationship. |
| `org_id` | string | Yes | ID of the Snyk organization that owns the project. |
| `project_id` | string | Yes | ID of the project to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update SAST Settings

**Slug:** `SNYK_UPDATE_SAST_SETTINGS`

Enable or disable Snyk Code SAST for an organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Exact JSON:API payload for the SAST settings update. |
| `org_id` | string | Yes | ID of the Snyk organization whose SAST settings are updated. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |