ContainerImage

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

List instances of container image

List instances of container image

GEThttps://api.snyk.io/rest/orgs/{org_id}/container_images

Path parameters

org_id*string (uuid)

Org ID

Example: "f59045b3-f093-40c3-871d-a334ae30c568"

Query parameters

Response

200400401403404409500

Returns a list of container image instances

Headers

Body

application/vnd.api+json

dataarray of Image (object)

jsonapiJsonApi (object)

linksPaginatedLinks (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/rest/orgs/{org_id}/container_images?version=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409500

{
  "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

Get instance of container image

GEThttps://api.snyk.io/rest/orgs/{org_id}/container_images/{image_id}

Path parameters

org_id*string (uuid)

Org ID

Example: "f59045b3-f093-40c3-871d-a334ae30c568"

image_id*string (uri)

Image ID

Example: "sha256:2bd864580926b790a22c8b96fd74496fe87b3c59c0774fe144bab2788e78e676"

Pattern: ^sha256(:|%3A)[a-f0-9]{64}$

Query parameters

Response

200400401403404409500

Returns an instance of container image

Headers

Body

application/vnd.api+json

dataImage (object)

jsonapiJsonApi (object)

linksSelfLink (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/rest/orgs/{org_id}/container_images/{image_id}?version=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409500

{
  "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

List instances of image target references for a container image

GEThttps://api.snyk.io/rest/orgs/{org_id}/container_images/{image_id}/relationships/image_target_refs

Path parameters

org_id*string (uuid)

Org ID

Example: "f59045b3-f093-40c3-871d-a334ae30c568"

image_id*string (uri)

Image ID

Example: "sha256:2bd864580926b790a22c8b96fd74496fe87b3c59c0774fe144bab2788e78e676"

Pattern: ^sha256(:|%3A)[a-f0-9]{64}$

Query parameters

Response

200400401403404409500

Returns a list of image target references for a container image

Headers

Body

application/vnd.api+json

dataarray of ImageTargetRef (object)

jsonapiJsonApi (object)

linksPaginatedLinks (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/rest/orgs/{org_id}/container_images/{image_id}/relationships/image_target_refs?version=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409500

{
  "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"
  }
}