Custom Base Images
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.
API key value must be prefixed with "Token ".
Requested API version
2021-06-04Pattern: ^(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))?))$Successfully created a custom base 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.
POST /rest/custom_base_images?version=text HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 176
{
"data": {
"attributes": {
"include_in_recommendations": true,
"project_id": "2cab3939-d112-4ef0-836d-e09c87cbe69b",
"versioning_schema": {
"type": "semver"
}
},
"type": "custom_base_image"
}
}{
"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 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.
API key value must be prefixed with "Token ".
Requested API version
2021-06-04Pattern: ^(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))?))$Return the page of results immediately after this cursor
v1.eyJpZCI6IjEwMDAifQo=Return the page of results immediately before this cursor
v1.eyJpZCI6IjExMDAifQo=Number of results to return per page
10Example: 10The ID of the container project that the custom base image is based off of.
The organization ID of the custom base image
The group ID of the custom base image
The image repository
The image tag
Whether this image should be recommended as a base image upgrade
Which column to sort by. If sorting by version, the versioning schema is used.
Which direction to sort
ASCPossible values: Returns custom base images
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.
Internal Server Error: An error was encountered while attempting to process the request.
GET /rest/custom_base_images?version=text HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*
{
"data": [
{
"attributes": {
"group_id": "123e4567-e89b-12d3-a456-426614174000",
"include_in_recommendations": true,
"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"
}
}Updates a custom base image's attributes
API key value must be prefixed with "Token ".
Unique identifier for custom base image
Requested API version
2021-06-04Pattern: ^(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 the updated custom base 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.
Internal Server Error: An error was encountered while attempting to process the request.
PATCH /rest/custom_base_images/{custombaseimage_id}?version=text HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 168
{
"data": {
"attributes": {
"include_in_recommendations": true,
"versioning_schema": {
"type": "semver"
}
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "custom_base_image"
}
}{
"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
API key value must be prefixed with "Token ".
Unique identifier for custom base image
Requested API version
2021-06-04Pattern: ^(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 a custom base 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.
Internal Server Error: An error was encountered while attempting to process the request.
GET /rest/custom_base_images/{custombaseimage_id}?version=text HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*
{
"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 resource. (the related container project is unaffected)
API key value must be prefixed with "Token ".
Unique identifier for custom base image
Requested API version
2021-06-04Pattern: ^(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))?))$Successfully deleted the custom base image
Unauthorized: the request requires an authentication token.
Not Found: The resource being operated on could not be found.
Internal Server Error: An error was encountered while attempting to process the request.
DELETE /rest/custom_base_images/{custombaseimage_id}?version=text HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*
No content
Last updated
Was this helpful?