Marketplace API

The Marketplace API serves as a catalog of available Instance images. Its goal is to help find the specific image ID to use when launching an Instance.

Users can launch Instances through the Instances API. These Instances use a predefined disk state, called an image. To launch an Instance with a specific image, you must know the image's ID to pass to the Instance API.

These IDs can change over time as the Scaleway team releases new versions of the images, so the Marketplace API can be used to find the most up-to-date image to use.

Concepts

Refer to the Instances concepts pageOpen in new context to learn more about images and other concepts related to Instances.

Quickstart

This API uses calls to the /local-images?image_label=<label> endpoint to get the IDs of specific images.

For example, make the following call to the endpoint /local-images?image_label=ubuntu_jammy&zone=fr-par-1 to get the local images for Ubuntu 22.04 LTS (Jammy Jellyfish) in the fr-par-1 Availability Zone:

Code
```bash
$ curl -X GET https://api.scaleway.com/marketplace/v2/local-images\?image_label\=ubuntu_jammy\&zone\=fr-par-1 |jq
```

The following list of images is returned:

Code
```bash
{
  "local_images": [
    {
      "id": "350a06b2-ecd0-48b9-ba9e-495a51345a68",
      "arch": "x86_64",
      "zone": "fr-par-1",
      "compatible_commercial_types": [
        [...]
        "STARDUST1-S",
        "PLAY2-MICRO",
        "PLAY2-NANO",
        "PLAY2-PICO"
      ],
      "label": "ubuntu_jammy"
    },
    {
      "id": "94299452-12c4-4d79-9c79-ced52967d75f",
      "arch": "arm64",
      "zone": "fr-par-1",
      "compatible_commercial_types": [
        "COPARM1-2C-8G",
        "COPARM1-4C-16G",
        [...]
      ],
      "label": "ubuntu_jammy"
    }
  ],
  "total_count": 2
}
```

Technical information

Availability Zones

Scaleway's infrastructure is spread across different regions and Availability ZonesOpen in new context.

The Marketplace API is a global API and provides information about Instance images in all Availability Zones.

Authentication

No authentication or API key is required to use the Marketplace API.

Pagination

Most listing requests receive a paginated response. Requests against paginated endpoints accept two query arguments:

• page, a positive integer to choose which page to return. The default value is 1.
• page_size, an positive integer lower or equal to 100 to select the number of items to return per page. The default value is 20.

Paginated endpoints usually also accept filters to search and sort results. These filters are documented along each endpoint documentation.

Going further

For more help using the Marketplace API, check out the following resources:

• Our Instances API documentationOpen in new context.