Marketplace Images
Marketplace Images represent the generalized images available through the Marketplace API. For each image, information returned includes its name (e.g. Arch Linux), description, category and label. Note that the IDs returned by this endpoint are not the IDs required by the Instance API to specify the image to install on an Instance. You can, however, use the IDs provided by this endpoint as a filter with the Marketplace Local Images to find the right local image for your Instance, and its ID
List marketplace images
List all available images on the marketplace, their UUID, CPU architecture and description.
query Parameters
include_eolChoose to include end-of-life images.
page_sizeA positive integer lower or equal to 100 to select the number of items to display.
pageA positive integer to choose the page to display.
order_byOrdering to use.
archChoose for which machine architecture to return images.
categoryChoose the category of images to get.
List marketplace images › Responses
total_countGet a specific marketplace image
Get detailed information about a marketplace image, specified by its image_id (UUID format).
path Parameters
image_idDisplay the image name. (UUID format)
Get a specific marketplace image › Responses
idUUID of this image. (UUID format)
nameName of the image.
descriptionText description of this image.
logoURL of this image's logo.
categoriesList of categories this image belongs to.
created_atCreation date of this image. (RFC 3339 format)
updated_atDate of the last modification of this image. (RFC 3339 format)
valid_untilExpiration date of this image. (RFC 3339 format)
labelLabel of this image. Typically an identifier for a distribution (ex. "ubuntu_focal"). This label can be used in the image field of the server creation request.