An image represents a container image. A container image is a file that includes all the requirements and instructions of a complete and executable version of an application. When running, it becomes one or multiple instances of that application.
The visibility of an image can be public - when anyone can pull it, private - when only users within your organization can pull it, or inherited from the namespace visibility - which is the default. The visibility of your image can be changed using the update image endpoit.
List images
List all images in a specified region. By default, the images listed are ordered by creation date in ascending order. This can be modified via the order_by field. You can also define additional parameters for your query, such as the namespace_id and project_id parameters.
path Parameters
regionThe region you want to target
query Parameters
pageA positive integer to choose the page to display.
page_sizeA positive integer lower or equal to 100 to select the number of items to display.
order_byCriteria to use when ordering image listings. Possible values are created_at_asc, created_at_desc, name_asc, name_desc, region, status_asc and status_desc. The default value is created_at_asc.
namespace_idFilter by the namespace ID.
nameFilter by the image name (exact match).
organization_idFilter by Organization ID.
project_idFilter by Project ID.
List images › Responses
Paginated list of images that match the selected filters.
total_countTotal number of images that match the selected filters.
Get an image
Retrieve information about a given container image, specified by its image_id and region. Full details about the image, such as name, namespace_id, status, visibility, and size are returned in the response.
path Parameters
regionThe region you want to target
image_idUUID of the image.
Get an image › Responses
idUUID of the image.
nameName of the image, it must be unique within the namespace.
namespace_idUUID of the namespace the image belongs to.
statusStatus of the image.
status_messageDetails of the image status.
visibilitySet to public to allow the image to be pulled without authentication. Else, set to private. Set to inherit to keep the same visibility configuration as the namespace.
sizeImage size in bytes, calculated from the size of image layers. Image size in bytes, calculated from the size of image layers. One layer used in two tags of the same image is counted once but one layer used in two images is counted twice. (in bytes)
created_atDate and time of image creation. (RFC 3339 format)
updated_atDate and time of last update. (RFC 3339 format)
tagsList of docker tags of the image.
Delete an image
Delete a given image. You must specify, in the endpoint, the region and image_id parameters of the image you want to delete.
path Parameters
regionThe region you want to target
image_idUUID of the image.
Delete an image › Responses
idUUID of the image.
nameName of the image, it must be unique within the namespace.
namespace_idUUID of the namespace the image belongs to.
statusStatus of the image.
status_messageDetails of the image status.
visibilitySet to public to allow the image to be pulled without authentication. Else, set to private. Set to inherit to keep the same visibility configuration as the namespace.
sizeImage size in bytes, calculated from the size of image layers. Image size in bytes, calculated from the size of image layers. One layer used in two tags of the same image is counted once but one layer used in two images is counted twice. (in bytes)
created_atDate and time of image creation. (RFC 3339 format)
updated_atDate and time of last update. (RFC 3339 format)
tagsList of docker tags of the image.
Update an image
Update the parameters of a given image, specified by its image_id and region. You can update the visibility parameter.
path Parameters
regionThe region you want to target
image_idID of the image to update.
Update an image › Request Body
visibilitySet to public to allow the image to be pulled without authentication. Else, set to private. Set to inherit to keep the same visibility configuration as the namespace.
Update an image › Responses
idUUID of the image.
nameName of the image, it must be unique within the namespace.
namespace_idUUID of the namespace the image belongs to.
statusStatus of the image.
status_messageDetails of the image status.
visibilitySet to public to allow the image to be pulled without authentication. Else, set to private. Set to inherit to keep the same visibility configuration as the namespace.
sizeImage size in bytes, calculated from the size of image layers. Image size in bytes, calculated from the size of image layers. One layer used in two tags of the same image is counted once but one layer used in two images is counted twice. (in bytes)
created_atDate and time of image creation. (RFC 3339 format)
updated_atDate and time of last update. (RFC 3339 format)
tagsList of docker tags of the image.