ContainerImage
Snyk API reference for the ContainerImage endpoints, including request parameters and response schemas
List instances of container image
Required permissions
View container images (org.container_image.read)
API key value must be prefixed with "Token ".
Org ID
f59045b3-f093-40c3-871d-a334ae30c568A comma-separated list of Image IDs
["sha256:b26f21f90920dba8401e30b89ad803587f81cce9bd1f92750f963556da2f930f","sha256:28984a62eb713aa5fff922ba06e8689f20e4b2f07de30f3d753b868389c0904f"]The image Operating System and processor architecture
linux/amd64Possible values: The container registry names
["gcr.io/snyk/redis:5"]Requested API version
2026-03-25Pattern: ^(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))?))$Number of results to return per page
10Example: 10Return the page of results immediately after this cursor
v1.eyJpZCI6IjEwMDAifQo=Return the page of results immediately before this cursor
v1.eyJpZCI6IjExMDAifQo=Returns a list of container image instances
Bad Request: A parameter provided as a part of the request was invalid.
Unauthorized: the request requires an authentication token.
Forbidden: the request requires an authentication token with more or different permissions.
Not Found: The resource being operated on could not be found.
Conflict: The requested operation conflicts with the current state of the resource in some way.
Internal Server Error: An error was encountered while attempting to process the request.
GET /rest/orgs/{org_id}/container_images?version=2026-03-25 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*
{
"data": [
{
"attributes": {
"layers": [
"sha256:2bd864580926b790a22c8b96fd74496fe87b3c59c0774fe144bab2788e78e676"
],
"names": [
"gcr.io/snyk/redis:5"
],
"platform": "linux/amd64"
},
"id": "sha256:2bd864580926b790a22c8b96fd74496fe87b3c59c0774fe144bab2788e78e676",
"relationships": {
"image_target_refs": {
"links": {
"self": "https://example.com/api/this_resource"
}
}
},
"type": "container_image"
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"first": "https://example.com/api/resource?ending_before=v1.eyJpZCI6IjExIn0K",
"last": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjMwIn0K",
"next": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjEwIn0K"
}
}Get instance of container image
Required permissions
View container images (org.container_image.read)
API key value must be prefixed with "Token ".
Org ID
f59045b3-f093-40c3-871d-a334ae30c568Image ID
sha256:2bd864580926b790a22c8b96fd74496fe87b3c59c0774fe144bab2788e78e676Pattern: ^sha256(:|%3A)[a-f0-9]{64}$Requested API version
2026-03-25Pattern: ^(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))?))$Returns an instance of container image
Bad Request: A parameter provided as a part of the request was invalid.
Unauthorized: the request requires an authentication token.
Forbidden: the request requires an authentication token with more or different permissions.
Not Found: The resource being operated on could not be found.
Conflict: The requested operation conflicts with the current state of the resource in some way.
Internal Server Error: An error was encountered while attempting to process the request.
GET /rest/orgs/{org_id}/container_images/{image_id}?version=2026-03-25 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*
{
"data": {
"attributes": {
"layers": [
"sha256:2bd864580926b790a22c8b96fd74496fe87b3c59c0774fe144bab2788e78e676"
],
"names": [
"gcr.io/snyk/redis:5"
],
"platform": "linux/amd64"
},
"id": "sha256:2bd864580926b790a22c8b96fd74496fe87b3c59c0774fe144bab2788e78e676",
"relationships": {
"image_target_refs": {
"links": {
"self": "https://example.com/api/this_resource"
}
}
},
"type": "container_image"
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "https://example.com/api/this_resource"
}
}List instances of image target references for a container image
Required permissions
View container images (org.container_image.read)
API key value must be prefixed with "Token ".
Org ID
f59045b3-f093-40c3-871d-a334ae30c568Image ID
sha256:2bd864580926b790a22c8b96fd74496fe87b3c59c0774fe144bab2788e78e676Pattern: ^sha256(:|%3A)[a-f0-9]{64}$Requested API version
2026-03-25Pattern: ^(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))?))$Number of results to return per page
10Example: 10Return the page of results immediately after this cursor
v1.eyJpZCI6IjEwMDAifQo=Return the page of results immediately before this cursor
v1.eyJpZCI6IjExMDAifQo=Returns a list of image target references for a container image
Bad Request: A parameter provided as a part of the request was invalid.
Unauthorized: the request requires an authentication token.
Forbidden: the request requires an authentication token with more or different permissions.
Not Found: The resource being operated on could not be found.
Conflict: The requested operation conflicts with the current state of the resource in some way.
Internal Server Error: An error was encountered while attempting to process the request.
GET /rest/orgs/{org_id}/container_images/{image_id}/relationships/image_target_refs?version=2026-03-25 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*
{
"data": [
{
"attributes": {
"platform": "linux/amd64",
"target_id": "123e4567-e89b-12d3-a456-426614174000",
"target_reference": "text"
},
"id": "3cd4af4c-fb15-45c4-9acd-8e8fcc6690af",
"type": "image_target_reference"
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"first": "https://example.com/api/resource?ending_before=v1.eyJpZCI6IjExIn0K",
"last": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjMwIn0K",
"next": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjEwIn0K"
}
}Last updated
Was this helpful?