Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Asset

Snyk API reference for the Asset endpoints, including request parameters and response schemas

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

Add alias for a repository asset in org (Early Access)

post

Link one or more alternate repository URLs to a canonical repository asset within an organisation, enabling alias-aware asset lookup.

Required permissions

  • Edit Organization (org.edit)
Authorizations
AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters
org_idstring · uuidRequired

Org ID

Query parameters
versionstringRequired

Requested API version

Example: 2026-09-09Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$
Body
Responses
204

Aliases created successfully

post/orgs/{org_id}/assets/repository/aliases
POST /rest/orgs/{org_id}/assets/repository/aliases?version=2026-09-09 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 142

{
  "data": [
    {
      "attributes": {
        "new_url": "https://github.com/org/repo-renamed.git",
        "url": "https://github.com/org/repo.git"
      },
      "type": "asset_aliases"
    }
  ]
}

No content

List repository aliases in org (Early Access)

get

Returns a paginated list of alias URL entries for repository assets within an organisation. Use the optional url filter to restrict results to a specific canonical document.

Required permissions

  • View Organization (org.read)
Authorizations
AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters
org_idstring · uuidRequired

Org ID

Query parameters
urlstringOptional

Optional repository URL filter — restricts results to the canonical document containing this URL

limitinteger · min: 10 · max: 100Optional

Maximum number of alias items to return per page. A single canonical document with multiple aliases may span more than one page.

Default: 10
starting_afterstringOptional

Return records after the record identified by this cursor

Example: v1.MTIzNDU2Nzg5MHxhYmNkZWY=
ending_beforestringOptional

Return records before the record identified by this cursor

Example: v1.MTIzNDU2Nzg5MHxhYmNkZWY=
versionstringRequired

Requested API version

Example: 2026-09-09Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$
Responses
200

Paginated list of repository alias entries

application/vnd.api+json
get/orgs/{org_id}/assets/repository/aliases
GET /rest/orgs/{org_id}/assets/repository/aliases?version=2026-09-09 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*
{
  "data": [
    {
      "attributes": {
        "new_url": "text",
        "url": "text"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "asset_aliases"
    }
  ],
  "jsonapi": {
    "version": "text"
  },
  "links": {
    "first": "https://example.com",
    "next": "https://example.com",
    "prev": "https://example.com",
    "self": "https://example.com"
  }
}

Bulk remove aliases from repository assets in org (Early Access)

delete

Detach one or more aliased URLs from their canonical repository assets within an organisation. Each removed URL gets a new standalone asset document.

Required permissions

  • Edit Organization (org.edit)
Authorizations
AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters
org_idstring · uuidRequired

Org ID

Query parameters
versionstringRequired

Requested API version

Example: 2026-09-09Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$
Body
Responses
204

Aliases removed successfully

delete/orgs/{org_id}/assets/repository/aliases
DELETE /rest/orgs/{org_id}/assets/repository/aliases?version=2026-09-09 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 186

{
  "data": [
    {
      "attributes": {
        "new_url": "https://github.com/org/repo-renamed.git",
        "url": "https://github.com/org/repo.git"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "asset_aliases"
    }
  ]
}

No content

Update asset attributes (Early Access)

patch

The endpoint allows for partial updates to an asset's attributes.

Required permissions

  • Edit Group Details (group.edit)
Authorizations
AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters
asset_idstring · uuidRequired

Unique identifier for the Asset

group_idstring · uuidRequired

Group ID

Query parameters
versionstringRequired

Requested API version

Example: 2026-09-09Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$
Body
Responses
200

Asset updated successfully

application/vnd.api+json
patch/groups/{group_id}/assets/{asset_id}
PATCH /rest/groups/{group_id}/assets/{asset_id}?version=2026-09-09 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 253

{
  "data": {
    "attributes": {
      "class": {
        "display_name": "A",
        "locked": true,
        "rank": 1
      },
      "labels": {
        "add": [
          "text"
        ],
        "remove": [
          "text"
        ]
      },
      "tags": {
        "add": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "remove": [
          "text"
        ]
      }
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "repository"
  }
}
{
  "data": {
    "attributes": {
      "app_context": {},
      "archived": true,
      "base_image": "text",
      "browse_url": "https://example.com",
      "class": {
        "display_name": "A",
        "locked": true,
        "rank": 1
      },
      "coverage_controls": [
        {
          "category": "security",
          "gap": true,
          "issues_count": {
            "critical": 1,
            "high": 2,
            "low": 0,
            "medium": 0
          },
          "last_scan": "2023-10-10T08:00:00Z",
          "name": "control1"
        }
      ],
      "created_at": "2026-01-01T00:00:00.000Z",
      "default_branch_name": "main",
      "developers": [
        {
          "discovered_by": "github",
          "email": "john.doe@example.com",
          "url": "https://github.com/johndoe",
          "username": "johndoe"
        }
      ],
      "file_path": "text",
      "id_from_source": "610306547",
      "image_digests": [
        "text"
      ],
      "image_id": "text",
      "image_registries": [
        "text"
      ],
      "image_repositories": [
        "text"
      ],
      "image_tags": [
        "text"
      ],
      "labels": [
        "text"
      ],
      "languages": {
        "ANY_ADDITIONAL_PROPERTY": 1
      },
      "name": "text",
      "removed_reasons": [
        {
          "reason": "deleted-profile",
          "removed_at": "2026-01-01T00:00:00.000Z"
        }
      ],
      "repository_freshness": "Ynl0ZXM=",
      "repository_url": "text",
      "sources": [
        "text"
      ],
      "tags": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "updated_at": "2026-01-01T00:00:00.000Z"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "relationships": {
      "assets": {
        "links": {
          "related": "text"
        }
      },
      "organizations": {
        "data": [
          {
            "attributes": {
              "name": "text"
            },
            "id": "text",
            "type": "text"
          }
        ]
      },
      "projects": {
        "links": {
          "related": "text"
        }
      }
    },
    "removed": true,
    "type": "repository"
  },
  "jsonapi": {
    "version": "text"
  },
  "links": {
    "self": "https://example.com/api/this_resource"
  }
}

Get an Asset by its ID (Early Access)

get

Get an Asset by its ID

Required permissions

  • View Groups (group.read)
Authorizations
AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters
asset_idstring · uuidRequired

Unique identifier for the Asset

group_idstring · uuidRequired

Group ID

Query parameters
versionstringRequired

Requested API version

Example: 2026-09-09Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$
Responses
200

Asset found

application/vnd.api+json
get/groups/{group_id}/assets/{asset_id}
GET /rest/groups/{group_id}/assets/{asset_id}?version=2026-09-09 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*
{
  "data": {
    "attributes": {
      "app_context": {},
      "archived": true,
      "base_image": "text",
      "browse_url": "https://example.com",
      "class": {
        "display_name": "A",
        "locked": true,
        "rank": 1
      },
      "coverage_controls": [
        {
          "category": "security",
          "gap": true,
          "issues_count": {
            "critical": 1,
            "high": 2,
            "low": 0,
            "medium": 0
          },
          "last_scan": "2023-10-10T08:00:00Z",
          "name": "control1"
        }
      ],
      "created_at": "2026-01-01T00:00:00.000Z",
      "default_branch_name": "main",
      "developers": [
        {
          "discovered_by": "github",
          "email": "john.doe@example.com",
          "url": "https://github.com/johndoe",
          "username": "johndoe"
        }
      ],
      "file_path": "text",
      "id_from_source": "610306547",
      "image_digests": [
        "text"
      ],
      "image_id": "text",
      "image_registries": [
        "text"
      ],
      "image_repositories": [
        "text"
      ],
      "image_tags": [
        "text"
      ],
      "labels": [
        "text"
      ],
      "languages": {
        "ANY_ADDITIONAL_PROPERTY": 1
      },
      "name": "text",
      "removed_reasons": [
        {
          "reason": "deleted-profile",
          "removed_at": "2026-01-01T00:00:00.000Z"
        }
      ],
      "repository_freshness": "Ynl0ZXM=",
      "repository_url": "text",
      "sources": [
        "text"
      ],
      "tags": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "updated_at": "2026-01-01T00:00:00.000Z"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "relationships": {
      "assets": {
        "links": {
          "related": "text"
        }
      },
      "organizations": {
        "data": [
          {
            "attributes": {
              "name": "text"
            },
            "id": "text",
            "type": "text"
          }
        ]
      },
      "projects": {
        "links": {
          "related": "text"
        }
      }
    },
    "removed": true,
    "type": "repository"
  },
  "jsonapi": {
    "version": "text"
  },
  "links": {
    "self": "https://example.com/api/this_resource"
  }
}

List asset projects with pagination (Early Access)

get

List asset projects with pagination

Required permissions

  • View Groups (group.read)
Authorizations
AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters
group_idstring · uuidRequired

Group ID

asset_idstring · uuidRequired

Unique identifier for the Asset

Query parameters
starting_afterstringOptional

Return records after the record identified by cursor position starting_after

ending_beforestringOptional

Return records before the record identified by cursor position ending_before

limitnumber · min: 10 · max: 100Optional

Number of records to return

Default: 10
versionstringRequired

Requested API version

Example: 2026-09-09Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$
Responses
200

Assets found

application/vnd.api+json
get/groups/{group_id}/assets/{asset_id}/relationships/projects
GET /rest/groups/{group_id}/assets/{asset_id}/relationships/projects?version=2026-09-09 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*
{
  "data": [
    {
      "attributes": {
        "issues_counts": {
          "critical": 1,
          "high": 1,
          "low": 1,
          "medium": 1
        },
        "last_scan": "text",
        "name": "text",
        "organization_id": "text",
        "organization_name": "text",
        "project_type": "text",
        "target_file": "text",
        "target_id": "text",
        "target_reference": "text",
        "test_surface": "text",
        "url": "text"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "project"
    }
  ],
  "jsonapi": {
    "version": "text"
  },
  "links": {
    "first": "https://example.com/api/resource",
    "last": "https://example.com/api/resource",
    "next": "https://example.com/api/resource",
    "prev": "https://example.com/api/resource",
    "related": "https://example.com/api/resource",
    "self": "https://example.com/api/resource"
  }
}

List related assets with pagination (Early Access)

get

List related assets with pagination

Required permissions

  • View Groups (group.read)
Authorizations
AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters
group_idstring · uuidRequired

Group ID

asset_idstring · uuidRequired

Unique identifier for the Asset

Query parameters
starting_afterstringOptional

Return records after the record identified by cursor position starting_after

ending_beforestringOptional

Return records before the record identified by cursor position ending_before

limitnumber · min: 10 · max: 100Optional

Number of records to return

Default: 10
versionstringRequired

Requested API version

Example: 2026-09-09Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$
typestring · enumOptional

Filter by asset type

Possible values:
Responses
200

Related assets found

application/vnd.api+json
get/groups/{group_id}/assets/{asset_id}/relationships/assets
GET /rest/groups/{group_id}/assets/{asset_id}/relationships/assets?version=2026-09-09 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*
{
  "data": [
    {
      "attributes": {
        "app_context": {},
        "archived": true,
        "base_image": "text",
        "browse_url": "https://example.com",
        "class": {
          "display_name": "A",
          "locked": true,
          "rank": 1
        },
        "coverage_controls": [
          {
            "category": "security",
            "gap": true,
            "issues_count": {
              "critical": 1,
              "high": 2,
              "low": 0,
              "medium": 0
            },
            "last_scan": "2023-10-10T08:00:00Z",
            "name": "control1"
          }
        ],
        "created_at": "2026-01-01T00:00:00.000Z",
        "default_branch_name": "main",
        "developers": [
          {
            "discovered_by": "github",
            "email": "john.doe@example.com",
            "url": "https://github.com/johndoe",
            "username": "johndoe"
          }
        ],
        "file_path": "text",
        "id_from_source": "610306547",
        "image_digests": [
          "text"
        ],
        "image_id": "text",
        "image_registries": [
          "text"
        ],
        "image_repositories": [
          "text"
        ],
        "image_tags": [
          "text"
        ],
        "labels": [
          "text"
        ],
        "languages": {
          "ANY_ADDITIONAL_PROPERTY": 1
        },
        "name": "text",
        "removed_reasons": [
          {
            "reason": "deleted-profile",
            "removed_at": "2026-01-01T00:00:00.000Z"
          }
        ],
        "repository_freshness": "Ynl0ZXM=",
        "repository_url": "text",
        "sources": [
          "text"
        ],
        "tags": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "updated_at": "2026-01-01T00:00:00.000Z"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "relationships": {
        "assets": {
          "links": {
            "related": "text"
          }
        },
        "organizations": {
          "data": [
            {
              "attributes": {
                "name": "text"
              },
              "id": "text",
              "type": "text"
            }
          ]
        },
        "projects": {
          "links": {
            "related": "text"
          }
        }
      },
      "removed": true,
      "type": "repository"
    }
  ],
  "jsonapi": {
    "version": "text"
  },
  "links": {
    "first": "https://example.com/api/resource",
    "last": "https://example.com/api/resource",
    "next": "https://example.com/api/resource",
    "prev": "https://example.com/api/resource",
    "related": "https://example.com/api/resource",
    "self": "https://example.com/api/resource"
  }
}

List Assets with filters (Early Access)

post

List Assets with filters

Required permissions

  • View Groups (group.read)
Authorizations
AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters
group_idstring · uuidRequired

Group ID

Query parameters
versionstringRequired

Requested API version

Example: 2026-09-09Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$
Body
objectOptional

Empty body

or
Responses
200

Assets found

application/vnd.api+json
post/groups/{group_id}/assets/search
POST /rest/groups/{group_id}/assets/search?version=2026-09-09 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 88

{
  "query": {
    "attributes": {
      "attribute": "type",
      "operator": "equal",
      "values": [
        "repository"
      ]
    }
  }
}
{
  "data": [
    {
      "attributes": {
        "app_context": {},
        "archived": true,
        "base_image": "text",
        "browse_url": "https://example.com",
        "class": {
          "display_name": "A",
          "locked": true,
          "rank": 1
        },
        "coverage_controls": [
          {
            "category": "security",
            "gap": true,
            "issues_count": {
              "critical": 1,
              "high": 2,
              "low": 0,
              "medium": 0
            },
            "last_scan": "2023-10-10T08:00:00Z",
            "name": "control1"
          }
        ],
        "created_at": "2026-01-01T00:00:00.000Z",
        "default_branch_name": "main",
        "developers": [
          {
            "discovered_by": "github",
            "email": "john.doe@example.com",
            "url": "https://github.com/johndoe",
            "username": "johndoe"
          }
        ],
        "file_path": "text",
        "id_from_source": "610306547",
        "image_digests": [
          "text"
        ],
        "image_id": "text",
        "image_registries": [
          "text"
        ],
        "image_repositories": [
          "text"
        ],
        "image_tags": [
          "text"
        ],
        "labels": [
          "text"
        ],
        "languages": {
          "ANY_ADDITIONAL_PROPERTY": 1
        },
        "name": "text",
        "removed_reasons": [
          {
            "reason": "deleted-profile",
            "removed_at": "2026-01-01T00:00:00.000Z"
          }
        ],
        "repository_freshness": "Ynl0ZXM=",
        "repository_url": "text",
        "sources": [
          "text"
        ],
        "tags": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "updated_at": "2026-01-01T00:00:00.000Z"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "relationships": {
        "assets": {
          "links": {
            "related": "text"
          }
        },
        "organizations": {
          "data": [
            {
              "attributes": {
                "name": "text"
              },
              "id": "text",
              "type": "text"
            }
          ]
        },
        "projects": {
          "links": {
            "related": "text"
          }
        }
      },
      "removed": true,
      "type": "repository"
    }
  ],
  "jsonapi": {
    "version": "text"
  },
  "links": {
    "first": "https://example.com/api/resource",
    "last": "https://example.com/api/resource",
    "next": "https://example.com/api/resource",
    "prev": "https://example.com/api/resource",
    "related": "https://example.com/api/resource",
    "self": "https://example.com/api/resource"
  }
}

Add alias for a repository asset in group (Early Access)

post

Link one or more alternate repository URLs to a canonical repository asset within a group, enabling alias-aware asset lookup.

Required permissions

  • Edit Group Details (group.edit)
Authorizations
AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters
group_idstring · uuidRequired

Group ID

Query parameters
versionstringRequired

Requested API version

Example: 2026-09-09Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$
Body
Responses
204

Aliases created successfully

post/groups/{group_id}/assets/repository/aliases
POST /rest/groups/{group_id}/assets/repository/aliases?version=2026-09-09 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 142

{
  "data": [
    {
      "attributes": {
        "new_url": "https://github.com/org/repo-renamed.git",
        "url": "https://github.com/org/repo.git"
      },
      "type": "asset_aliases"
    }
  ]
}

No content

List repository aliases in group (Early Access)

get

Returns a paginated list of alias URL entries for repository assets within a group. Use the optional url filter to restrict results to a specific canonical document.

Required permissions

  • View Groups (group.read)
Authorizations
AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters
group_idstring · uuidRequired

Group ID

Query parameters
urlstringOptional

Optional repository URL filter — restricts results to the canonical document containing this URL

limitinteger · min: 10 · max: 100Optional

Maximum number of alias items to return per page. A single canonical document with multiple aliases may span more than one page.

Default: 10
starting_afterstringOptional

Return records after the record identified by this cursor

Example: v1.MTIzNDU2Nzg5MHxhYmNkZWY=
ending_beforestringOptional

Return records before the record identified by this cursor

Example: v1.MTIzNDU2Nzg5MHxhYmNkZWY=
versionstringRequired

Requested API version

Example: 2026-09-09Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$
Responses
200

Paginated list of repository alias entries

application/vnd.api+json
get/groups/{group_id}/assets/repository/aliases
GET /rest/groups/{group_id}/assets/repository/aliases?version=2026-09-09 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*
{
  "data": [
    {
      "attributes": {
        "new_url": "text",
        "url": "text"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "asset_aliases"
    }
  ],
  "jsonapi": {
    "version": "text"
  },
  "links": {
    "first": "https://example.com",
    "next": "https://example.com",
    "prev": "https://example.com",
    "self": "https://example.com"
  }
}

Bulk remove aliases from repository assets in group (Early Access)

delete

Detach one or more aliased URLs from their canonical repository assets within a group. Each removed URL gets a new standalone asset document.

Required permissions

  • Edit Group Details (group.edit)
Authorizations
AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters
group_idstring · uuidRequired

Group ID

Query parameters
versionstringRequired

Requested API version

Example: 2026-09-09Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$
Body
Responses
204

Aliases removed successfully

delete/groups/{group_id}/assets/repository/aliases
DELETE /rest/groups/{group_id}/assets/repository/aliases?version=2026-09-09 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 186

{
  "data": [
    {
      "attributes": {
        "new_url": "https://github.com/org/repo-renamed.git",
        "url": "https://github.com/org/repo.git"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "asset_aliases"
    }
  ]
}

No content

Last updated

Was this helpful?