Scaleway logo
Marketplace API
Marketplace API

Marketplace Images

Download schema

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

GET
https://api.scaleway.com
/marketplace/v2/images

List all available images on the marketplace, their UUID, CPU architecture and description.

List marketplace images › query Parameters

include_eol
​boolean · required

Choose to include end-of-life images.

page_size
​integer · uint32

A positive integer lower or equal to 100 to select the number of items to display.

page
​integer · int32

A positive integer to choose the page to display.

Ordering to use.

Enum values:
name_asc
name_desc
created_at_asc
created_at_desc
updated_at_asc
updated_at_desc
Default: name_asc
arch
​string

Choose for which machine architecture to return images.

category
​string

Choose the category of images to get.

List marketplace images › Responses

Get a specific marketplace image

GET
https://api.scaleway.com
/marketplace/v2/images/{image_id}

Get detailed information about a marketplace image, specified by its image_id (UUID format).

Get a specific marketplace image › path Parameters

image_id
​string · required

Display the image name. (UUID format)

Get a specific marketplace image › Responses

200
scaleway.marketplace.v2.Image
id
​string

UUID of this image. (UUID format)

name
​string

Name of the image.

description
​string

Text description of this image.

logo
​string

URL of this image's logo.

categories
​string[]

List of categories this image belongs to.

created_at
​string | null · date-time

Creation date of this image. (RFC 3339 format)

updated_at
​string | null · date-time

Date of the last modification of this image. (RFC 3339 format)

valid_until
​string | null · date-time

Expiration date of this image. (RFC 3339 format)

label
​string

Label 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.

Marketplace Local Images