Scaleway logo
Marketplace API
Marketplace API

Marketplace Local Images

Download schema

Marketplace Local Images represent the local images available to be installed on Scaleway Instances. Each local image is specific to an Availability Zone, and has an ID (which can be used with the Instance API to request installation of this image) as well as information about its zone, compatible Instance types, supported architecture, and label (typically an identifier for the distribution). If the same distribution is available on multiple Availability Zones, it will have one local image per Availability Zone. When selecting an image to install on an Instance, you must ensure that it is compatible with that Instance in terms of zone, architecture, Instance type etc

List local images from a specific image or version

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

List information about local images in a specific Availability Zone, specified by its image_id (UUID format), version_id (UUID format) or image_label. Only one of these three parameters may be set.

List local images from a specific image or version › query Parameters

zone
​string · required

Filter local images available on this Availability Zone.

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:
type_asc
type_desc
created_at_asc
created_at_desc
Default: type_asc
arch
​string

Filter local images available for this machine architecture.

Filter by type.

Enum values:
unknown_type
instance_local
instance_sbs
Default: unknown_type

List local images from a specific image or version › Responses

Get a specific local image by ID

GET
https://api.scaleway.com
/marketplace/v2/local-images/{local_image_id}

Get detailed information about a local image, including compatible commercial types, supported architecture, labels and the Availability Zone of the image, specified by its local_image_id (UUID format).

Get a specific local image by ID › path Parameters

local_image_id
​string · required

(UUID format)

Get a specific local image by ID › Responses

200
scaleway.marketplace.v2.LocalImage
id
​string

UUID of this local image. Version you will typically use to define an image in an API call. (UUID format)

compatible_commercial_types
​string[]

List of all commercial types that are compatible with this local image.

arch
​string

Supported architecture for this local image.

zone
​string

Availability Zone where this local image is available.

label
​string

Image label this image belongs to. This label can be used in the image field of the server creation request.

Type of this local image.

Enum values:
unknown_type
instance_local
instance_sbs
Default: unknown_type
Marketplace ImagesMarketplace Image Versions