Asset Projects

This document uses the REST API. For more details, see the Authentication for API page.

List projects for an asset (Early Access)

get

Retrieves a paginated list of Snyk projects linked to this asset with full attributes. Returns the id, type, and attributes of each related project.

Required permissions

• View Tenant Details (tenant.read)

Authorizations

APITokenBearerAuth

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

tenant_idstring · uuidRequired

The unique identifier of the tenant

asset_idstring · uuidRequired

The unique identifier of the asset

Query parameters

versionstringOptional

The requested API version

Example: 2024-10-15Pattern: ^\d{4}-\d{2}-\d{2}$

starting_afterstringOptional

Cursor for fetching the next page of results

ending_beforestringOptional

Cursor for fetching the previous page of results

limitinteger · min: 10 · max: 100Optional

Maximum number of results to return per page

Default: 10

canonicalstring · enumOptional

Filter projects by canonical status.

• with: Returns all projects (canonical attribute is populated).
• only: Returns only canonical projects (those used for vulnerability counts).
• none: Returns only non-canonical projects. When omitted, returns all projects without canonical filtering.

Possible values:

target_idstring · uuidOptional

Filter projects by target ID. When provided, returns only projects that belong to the specified target. When omitted, returns projects from all targets.

Responses

200

Successfully retrieved linked projects

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

get

/tenants/{tenant_id}/inventory/assets/{asset_id}/relationships/projects

HTTPcURLJavaScriptPython

GET /rest/tenants/{tenant_id}/inventory/assets/{asset_id}/relationships/projects HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "attributes": {
        "is_canonical": true,
        "issues": {
          "critical": 1,
          "high": 1,
          "low": 1,
          "medium": 1
        },
        "monitor_created_at": "2026-02-24T01:58:31.409Z",
        "monitor_id": "123e4567-e89b-12d3-a456-426614174000",
        "project_type": "npm",
        "risk_score": 1,
        "snapshot_created_at": "2026-02-24T01:58:31.409Z",
        "snapshot_id": "123e4567-e89b-12d3-a456-426614174000",
        "target_file": "text",
        "target_id": "123e4567-e89b-12d3-a456-426614174000",
        "target_origin": "text",
        "target_ref": "text"
      },
      "id": "11111111-2222-3333-4444-555555555555",
      "type": "project"
    }
  ],
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "related": "https://example.com",
    "self": "https://example.com",
    "first": "https://example.com",
    "next": "https://example.com",
    "prev": "https://example.com"
  }
}

List projects for an asset (org scope) (Early Access)

get

Retrieves a paginated list of Snyk projects linked to this asset with full attributes. Returns the id, type, and attributes of each related project. Scoped to the specified organization.

Required permissions

• View Organization (org.read)

Authorizations

APITokenBearerAuth

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

org_idstring · uuidRequired

The unique identifier of the organization

asset_idstring · uuidRequired

The unique identifier of the asset

Query parameters

versionstringOptional

The requested API version

Example: 2024-10-15Pattern: ^\d{4}-\d{2}-\d{2}$

starting_afterstringOptional

Cursor for fetching the next page of results

ending_beforestringOptional

Cursor for fetching the previous page of results

limitinteger · min: 10 · max: 100Optional

Maximum number of results to return per page

Default: 10

canonicalstring · enumOptional

Filter projects by canonical status.

• with: Returns all projects (canonical attribute is populated).
• only: Returns only canonical projects (those used for vulnerability counts).
• none: Returns only non-canonical projects. When omitted, returns all projects without canonical filtering.

Possible values:

target_idstring · uuidOptional

Filter projects by target ID. When provided, returns only projects that belong to the specified target. When omitted, returns projects from all targets.

Responses

200

Successfully retrieved linked projects

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

get

/orgs/{org_id}/inventory/assets/{asset_id}/relationships/projects

HTTPcURLJavaScriptPython

GET /rest/orgs/{org_id}/inventory/assets/{asset_id}/relationships/projects HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "attributes": {
        "is_canonical": true,
        "issues": {
          "critical": 1,
          "high": 1,
          "low": 1,
          "medium": 1
        },
        "monitor_created_at": "2026-02-24T01:58:31.409Z",
        "monitor_id": "123e4567-e89b-12d3-a456-426614174000",
        "project_type": "npm",
        "risk_score": 1,
        "snapshot_created_at": "2026-02-24T01:58:31.409Z",
        "snapshot_id": "123e4567-e89b-12d3-a456-426614174000",
        "target_file": "text",
        "target_id": "123e4567-e89b-12d3-a456-426614174000",
        "target_origin": "text",
        "target_ref": "text"
      },
      "id": "11111111-2222-3333-4444-555555555555",
      "type": "project"
    }
  ],
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "related": "https://example.com",
    "self": "https://example.com",
    "first": "https://example.com",
    "next": "https://example.com",
    "prev": "https://example.com"
  }
}

List projects for an asset (group scope) (Early Access)

get

Retrieves a paginated list of Snyk projects linked to this asset with full attributes. Returns the id, type, and attributes of each related project. Scoped to the specified group.

Required permissions

• View Groups (group.read)

Authorizations

APITokenBearerAuth

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

group_idstring · uuidRequired

The unique identifier of the group

asset_idstring · uuidRequired

The unique identifier of the asset

Query parameters

versionstringOptional

The requested API version

Example: 2024-10-15Pattern: ^\d{4}-\d{2}-\d{2}$

starting_afterstringOptional

Cursor for fetching the next page of results

ending_beforestringOptional

Cursor for fetching the previous page of results

limitinteger · min: 10 · max: 100Optional

Maximum number of results to return per page

Default: 10

canonicalstring · enumOptional

Filter projects by canonical status.

• with: Returns all projects (canonical attribute is populated).
• only: Returns only canonical projects (those used for vulnerability counts).
• none: Returns only non-canonical projects. When omitted, returns all projects without canonical filtering.

Possible values:

target_idstring · uuidOptional

Filter projects by target ID. When provided, returns only projects that belong to the specified target. When omitted, returns projects from all targets.

Responses

200

Successfully retrieved linked projects

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

get

/groups/{group_id}/inventory/assets/{asset_id}/relationships/projects

HTTPcURLJavaScriptPython

GET /rest/groups/{group_id}/inventory/assets/{asset_id}/relationships/projects HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "attributes": {
        "is_canonical": true,
        "issues": {
          "critical": 1,
          "high": 1,
          "low": 1,
          "medium": 1
        },
        "monitor_created_at": "2026-02-24T01:58:31.409Z",
        "monitor_id": "123e4567-e89b-12d3-a456-426614174000",
        "project_type": "npm",
        "risk_score": 1,
        "snapshot_created_at": "2026-02-24T01:58:31.409Z",
        "snapshot_id": "123e4567-e89b-12d3-a456-426614174000",
        "target_file": "text",
        "target_id": "123e4567-e89b-12d3-a456-426614174000",
        "target_origin": "text",
        "target_ref": "text"
      },
      "id": "11111111-2222-3333-4444-555555555555",
      "type": "project"
    }
  ],
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "related": "https://example.com",
    "self": "https://example.com",
    "first": "https://example.com",
    "next": "https://example.com",
    "prev": "https://example.com"
  }
}