Custom Base Images

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

Create a Custom Base Image from an existing container project

In order to create a custom base image, you first need to import your base images into Snyk. You can do this through the CLI, UI, or API.

This endpoint marks an image as a custom base image. This means that the image will get added to the pool of images from which Snyk can recommend base image upgrades.

Note, after the first image in a repository gets added, a versioning schema cannot be passed in this endpoint. To update the versioning schema, the PATCH endpoint must be used.

POSThttps://api.snyk.io/rest/custom_base_images

Query parameters

Body

application/vnd.api+json

The properties used in the creation of a custom base image

data*object

Response

201400401403404409500

Successfully created a custom base image

Headers

Body

application/vnd.api+json

data*CustomBaseImageResource (object)

jsonapi*JsonApi (object)

linksSelfLink (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/rest/custom_base_images?version=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/vnd.api+json"
    },
    body: JSON.stringify({
      "data": {
        "type": "custom_base_image",
        "attributes": {
          "project_id": "2cab3939-d112-4ef0-836d-e09c87cbe69b",
          "include_in_recommendations": true
        }
      }
    }),
});
const data = await response.json();

Response

201400401403404409500

{
  "data": {
    "attributes": {
      "include_in_recommendations": true,
      "project_id": "2cab3939-d112-4ef0-836d-e09c87cbe69b",
      "versioning_schema": {
        "type": "semver"
      }
    },
    "id": "2cab3939-d112-4ef0-836d-e09c87cbe69b",
    "type": "custom_base_image"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://example.com/api/this_resource"
  }
}

Get a custom base image collection

Get a list of custom base images with support for ordering and filtering. Either the org_id or group_id parameters must be set to authorize successfully. If sorting by version, the repository filter is required.

GEThttps://api.snyk.io/rest/custom_base_images

Query parameters

Response

200400401403404500

Returns custom base images

Headers

Body

application/vnd.api+json

data*array of object

jsonapi*JsonApi (object)

linksPaginatedLinks (object)

Request

JavaScriptCurlPython

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

Response

200400401403404500

{
  "data": [
    {
      "attributes": {
        "group_id": "123e4567-e89b-12d3-a456-426614174000",
        "include_in_recommendations": false,
        "org_id": "123e4567-e89b-12d3-a456-426614174000",
        "project_id": "123e4567-e89b-12d3-a456-426614174000",
        "repository": "text",
        "tag": "text"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text"
    }
  ],
  "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"
  }
}

Update a custom base image

Updates a custom base image's attributes

PATCHhttps://api.snyk.io/rest/custom_base_images/{custombaseimage_id}

Path parameters

custombaseimage_id*string (uuid)

Unique identifier for custom base image

Query parameters

Body

application/vnd.api+json

custom base image to be updated

data*object

Response

200400401403404500

Returns the updated custom base image

Headers

Body

application/vnd.api+json

data*CustomBaseImageResource (object)

jsonapi*JsonApi (object)

linksSelfLink (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/rest/custom_base_images/{custombaseimage_id}?version=text', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/vnd.api+json"
    },
    body: JSON.stringify({
      "data": {
        "type": "custom_base_image",
        "attributes": {}
      }
    }),
});
const data = await response.json();

Response

200400401403404500

{
  "data": {
    "attributes": {
      "include_in_recommendations": true,
      "project_id": "2cab3939-d112-4ef0-836d-e09c87cbe69b",
      "versioning_schema": {
        "type": "semver"
      }
    },
    "id": "2cab3939-d112-4ef0-836d-e09c87cbe69b",
    "type": "custom_base_image"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://example.com/api/this_resource"
  }
}

Get a custom base image

Get a custom base image

GEThttps://api.snyk.io/rest/custom_base_images/{custombaseimage_id}

Path parameters

custombaseimage_id*string (uuid)

Unique identifier for custom base image

Query parameters

Response

200400401403404500

Returns a custom base image

Headers

Body

application/vnd.api+json

data*CustomBaseImageResource (object)

jsonapi*JsonApi (object)

linksSelfLink (object)

Request

JavaScriptCurlPython

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

Response

200400401403404500

{
  "data": {
    "attributes": {
      "include_in_recommendations": true,
      "project_id": "2cab3939-d112-4ef0-836d-e09c87cbe69b",
      "versioning_schema": {
        "type": "semver"
      }
    },
    "id": "2cab3939-d112-4ef0-836d-e09c87cbe69b",
    "type": "custom_base_image"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://example.com/api/this_resource"
  }
}

Delete a custom base image

Delete a custom base image resource. (the related container project is unaffected)

DELETEhttps://api.snyk.io/rest/custom_base_images/{custombaseimage_id}

Path parameters

custombaseimage_id*string (uuid)

Unique identifier for custom base image

Query parameters

Response

204401404500

Successfully deleted the custom base image

Headers

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/rest/custom_base_images/{custombaseimage_id}?version=text', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

401404500

{
  "errors": [
    {
      "detail": "Permission denied for this resource",
      "status": "403"
    }
  ],
  "jsonapi": {
    "version": "1.0"
  }
}