Images

Download schema

Images are backups of your Instances. One image will contain all the volumes of your Instance and can be used to restore your Instance and its data. You can also use it to create a series of Instances with a predefined configuration. To copy not all but only one specified volume of an Instance, you can use the snapshot feature instead.

List Instance images

GET

https://api.scaleway.com

/instance/v1/zones/{zone}/images

List all existing Instance images.

List Instance images › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

List Instance images › query Parameters

organization

google.protobuf.StringValue

per_page

integer · uint32

page

google.protobuf.Int32Value · int32

name

google.protobuf.StringValue

public

google.protobuf.BoolValue

arch

google.protobuf.StringValue

project

google.protobuf.StringValue

tags

google.protobuf.StringValue

List Instance images › Responses

200

scaleway.instance.v1.ListImagesResponse

scaleway.instance.v1.Image[]

List of images.

GET/instance/v1/zones/{zone}/images

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/instance/v1/zones/{zone}/images"

Example Responses

{
  "images": [
    {
      "id": "id",
      "name": "name",
      "arch": "unknown_arch",
      "creation_date": "2022-03-22T12:34:56.123456Z",
      "modification_date": "2022-03-22T12:34:56.123456Z",
      "default_bootscript": {
        "architecture": "unknown_arch",
        "bootcmdargs": "bootcmdargs",
        "default": true,
        "dtb": "dtb",
        "id": "id",
        "initrd": "initrd",
        "kernel": "kernel",
        "organization": "organization",
        "public": true,
        "title": "title",
        "project": "project",
        "zone": "zone"
      },
      "extra_volumes": {
        "<extra_volumeKey>": {
          "id": "id",
          "name": "name",
          "export_uri": "export_uri",
          "size": 0,
          "volume_type": "l_ssd",
          "creation_date": "2022-03-22T12:34:56.123456Z",
          "modification_date": "2022-03-22T12:34:56.123456Z",
          "organization": "organization",
          "project": "project",
          "tags": [
            "string"
          ],
          "server": {
            "id": "id",
            "name": "name"
          },
          "state": "available",
          "zone": "zone"
        }
      },
      "from_server": "from_server",
      "organization": "organization",
      "public": true,
      "root_volume": {
        "id": "id",
        "name": "name",
        "size": 0,
        "volume_type": "l_ssd"
      },
      "state": "available",
      "project": "project",
      "tags": [
        "string"
      ],
      "zone": "zone"
    }
  ]
}

json

application/json

Create an Instance image

POST

https://api.scaleway.com

/instance/v1/zones/{zone}/images

Create an Instance image from the specified snapshot ID.

Create an Instance image › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

Create an Instance image › Request Body

root_volume

string · required

UUID of the snapshot.

arch

scaleway.instance.v1.Arch · enum · required

Architecture of the image.

Enum values:

unknown_arch

x86_64

arm

arm64

Default: unknown_arch

name

string

Name of the image.

object

Additional volumes of the image.

project

string | null

Project ID of the image.

tags

string[]

Tags of the image.

public

boolean | null

True to create a public image.

Create an Instance image › Responses

scaleway.instance.v1.CreateImageResponse

scaleway.instance.v1.Image

POST/instance/v1/zones/{zone}/images

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "arch": "unknown_arch",
    "extra_volumes": {
        "<extra_volumeKey>": ""
    },
    "name": "string",
    "root_volume": "string"
  }' \
  "https://api.scaleway.com/instance/v1/zones/{zone}/images"

Example Request Body

{
  "name": "name",
  "root_volume": "root_volume",
  "arch": "unknown_arch",
  "extra_volumes": {
    "<extra_volumeKey>": {
      "id": "id",
      "name": "name",
      "size": 0,
      "volume_type": "l_ssd",
      "organization": "organization",
      "project": "project"
    }
  },
  "organization": "organization",
  "project": "project",
  "tags": [
    "string"
  ],
  "public": true
}

json

Example Responses

{
  "image": {
    "id": "id",
    "name": "name",
    "arch": "unknown_arch",
    "creation_date": "2022-03-22T12:34:56.123456Z",
    "modification_date": "2022-03-22T12:34:56.123456Z",
    "default_bootscript": {
      "architecture": "unknown_arch",
      "bootcmdargs": "bootcmdargs",
      "default": true,
      "dtb": "dtb",
      "id": "id",
      "initrd": "initrd",
      "kernel": "kernel",
      "organization": "organization",
      "public": true,
      "title": "title",
      "project": "project",
      "zone": "zone"
    },
    "extra_volumes": {
      "<extra_volumeKey>": {
        "id": "id",
        "name": "name",
        "export_uri": "export_uri",
        "size": 0,
        "volume_type": "l_ssd",
        "creation_date": "2022-03-22T12:34:56.123456Z",
        "modification_date": "2022-03-22T12:34:56.123456Z",
        "organization": "organization",
        "project": "project",
        "tags": [
          "string"
        ],
        "server": {
          "id": "id",
          "name": "name"
        },
        "state": "available",
        "zone": "zone"
      }
    },
    "from_server": "from_server",
    "organization": "organization",
    "public": true,
    "root_volume": {
      "id": "id",
      "name": "name",
      "size": 0,
      "volume_type": "l_ssd"
    },
    "state": "available",
    "project": "project",
    "tags": [
      "string"
    ],
    "zone": "zone"
  }
}

json

application/json

Update image

PUT

https://api.scaleway.com

/instance/v1/zones/{zone}/images/{id}

Replace all image properties with an image message.

Update image › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

id

string · required

Update image › Request Body

name

string

arch

scaleway.instance.v1.Arch · enum

Enum values:

unknown_arch

x86_64

arm

arm64

Default: unknown_arch

creation_date

string | null · date-time

(RFC 3339 format)

modification_date

string | null · date-time

(RFC 3339 format)

object

from_server

string

organization

string

public

boolean

scaleway.instance.v1.VolumeSummary

state

scaleway.instance.v1.Image.State · enum

Enum values:

available

creating

error

Default: available

project

string

tags

scaleway.std.StringsValue

Update image › Responses

200

scaleway.instance.v1.SetImageResponse

scaleway.instance.v1.Image

PUT/instance/v1/zones/{zone}/images/{id}

curl -X PUT \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "extra_volumes": {
        "<extra_volumeKey>": ""
    },
    "from_server": "string",
    "name": "string",
    "organization": "string",
    "project": "string",
    "public": false
  }' \
  "https://api.scaleway.com/instance/v1/zones/{zone}/images/{id}"

Example Request Body

{
  "name": "name",
  "arch": "unknown_arch",
  "creation_date": "2022-03-22T12:34:56.123456Z",
  "modification_date": "2022-03-22T12:34:56.123456Z",
  "default_bootscript": {
    "architecture": "unknown_arch",
    "bootcmdargs": "bootcmdargs",
    "default": true,
    "dtb": "dtb",
    "id": "id",
    "initrd": "initrd",
    "kernel": "kernel",
    "organization": "organization",
    "public": true,
    "title": "title",
    "project": "project",
    "zone": "zone"
  },
  "extra_volumes": {
    "<extra_volumeKey>": {
      "id": "id",
      "name": "name",
      "export_uri": "export_uri",
      "size": 0,
      "volume_type": "l_ssd",
      "creation_date": "2022-03-22T12:34:56.123456Z",
      "modification_date": "2022-03-22T12:34:56.123456Z",
      "organization": "organization",
      "project": "project",
      "tags": [
        "string"
      ],
      "server": {
        "id": "id",
        "name": "name"
      },
      "state": "available",
      "zone": "zone"
    }
  },
  "from_server": "from_server",
  "organization": "organization",
  "public": true,
  "root_volume": {
    "id": "id",
    "name": "name",
    "size": 0,
    "volume_type": "l_ssd"
  },
  "state": "available",
  "project": "project",
  "tags": []
}

json

Example Responses

{
  "image": {
    "id": "id",
    "name": "name",
    "arch": "unknown_arch",
    "creation_date": "2022-03-22T12:34:56.123456Z",
    "modification_date": "2022-03-22T12:34:56.123456Z",
    "default_bootscript": {
      "architecture": "unknown_arch",
      "bootcmdargs": "bootcmdargs",
      "default": true,
      "dtb": "dtb",
      "id": "id",
      "initrd": "initrd",
      "kernel": "kernel",
      "organization": "organization",
      "public": true,
      "title": "title",
      "project": "project",
      "zone": "zone"
    },
    "extra_volumes": {
      "<extra_volumeKey>": {
        "id": "id",
        "name": "name",
        "export_uri": "export_uri",
        "size": 0,
        "volume_type": "l_ssd",
        "creation_date": "2022-03-22T12:34:56.123456Z",
        "modification_date": "2022-03-22T12:34:56.123456Z",
        "organization": "organization",
        "project": "project",
        "tags": [
          "string"
        ],
        "server": {
          "id": "id",
          "name": "name"
        },
        "state": "available",
        "zone": "zone"
      }
    },
    "from_server": "from_server",
    "organization": "organization",
    "public": true,
    "root_volume": {
      "id": "id",
      "name": "name",
      "size": 0,
      "volume_type": "l_ssd"
    },
    "state": "available",
    "project": "project",
    "tags": [
      "string"
    ],
    "zone": "zone"
  }
}

json

application/json

Get an Instance image

GET

https://api.scaleway.com

/instance/v1/zones/{zone}/images/{image_id}

Get details of an image with the specified ID.

Get an Instance image › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

image_id

string · required

UUID of the image you want to get.

Get an Instance image › Responses

200

scaleway.instance.v1.GetImageResponse

scaleway.instance.v1.Image

GET/instance/v1/zones/{zone}/images/{image_id}

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/instance/v1/zones/{zone}/images/{image_id}"

Example Responses

{
  "image": {
    "id": "id",
    "name": "name",
    "arch": "unknown_arch",
    "creation_date": "2022-03-22T12:34:56.123456Z",
    "modification_date": "2022-03-22T12:34:56.123456Z",
    "default_bootscript": {
      "architecture": "unknown_arch",
      "bootcmdargs": "bootcmdargs",
      "default": true,
      "dtb": "dtb",
      "id": "id",
      "initrd": "initrd",
      "kernel": "kernel",
      "organization": "organization",
      "public": true,
      "title": "title",
      "project": "project",
      "zone": "zone"
    },
    "extra_volumes": {
      "<extra_volumeKey>": {
        "id": "id",
        "name": "name",
        "export_uri": "export_uri",
        "size": 0,
        "volume_type": "l_ssd",
        "creation_date": "2022-03-22T12:34:56.123456Z",
        "modification_date": "2022-03-22T12:34:56.123456Z",
        "organization": "organization",
        "project": "project",
        "tags": [
          "string"
        ],
        "server": {
          "id": "id",
          "name": "name"
        },
        "state": "available",
        "zone": "zone"
      }
    },
    "from_server": "from_server",
    "organization": "organization",
    "public": true,
    "root_volume": {
      "id": "id",
      "name": "name",
      "size": 0,
      "volume_type": "l_ssd"
    },
    "state": "available",
    "project": "project",
    "tags": [
      "string"
    ],
    "zone": "zone"
  }
}

json

application/json

Delete an Instance image

DELETE

https://api.scaleway.com

/instance/v1/zones/{zone}/images/{image_id}

Delete the image with the specified ID.

Delete an Instance image › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

image_id

string · required

UUID of the image you want to delete.

Delete an Instance image › Responses

No data returned

Update image

PATCH

https://api.scaleway.com

/instance/v1/zones/{zone}/images/{image_id}

Update the properties of an image.

Update image › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

image_id

string · required

UUID of the image. (UUID format)

Update image › Request Body

name

string | null

Name of the image.

arch

scaleway.instance.v1.Arch · enum

Architecture of the image.

Enum values:

unknown_arch

x86_64

arm

arm64

Default: unknown_arch

object

Additional snapshots of the image, with extra_volumeKey being the position of the snapshot in the image.

tags

array | null

Tags of the image.

public

boolean | null

True to set the image as public.

Update image › Responses

200

scaleway.instance.v1.UpdateImageResponse

scaleway.instance.v1.Image

PATCH/instance/v1/zones/{zone}/images/{image_id}

curl -X PATCH \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"extra_volumes":{"<extra_volumeKey>":""}}' \
  "https://api.scaleway.com/instance/v1/zones/{zone}/images/{image_id}"

Example Request Body

{
  "name": "name",
  "arch": "unknown_arch",
  "extra_volumes": {
    "<extra_volumeKey>": {
      "id": "6170692e-7363-616c-6577-61792e636f6d"
    }
  },
  "tags": [],
  "public": true
}

json

Example Responses

{
  "image": {
    "id": "id",
    "name": "name",
    "arch": "unknown_arch",
    "creation_date": "2022-03-22T12:34:56.123456Z",
    "modification_date": "2022-03-22T12:34:56.123456Z",
    "default_bootscript": {
      "architecture": "unknown_arch",
      "bootcmdargs": "bootcmdargs",
      "default": true,
      "dtb": "dtb",
      "id": "id",
      "initrd": "initrd",
      "kernel": "kernel",
      "organization": "organization",
      "public": true,
      "title": "title",
      "project": "project",
      "zone": "zone"
    },
    "extra_volumes": {
      "<extra_volumeKey>": {
        "id": "id",
        "name": "name",
        "export_uri": "export_uri",
        "size": 0,
        "volume_type": "l_ssd",
        "creation_date": "2022-03-22T12:34:56.123456Z",
        "modification_date": "2022-03-22T12:34:56.123456Z",
        "organization": "organization",
        "project": "project",
        "tags": [
          "string"
        ],
        "server": {
          "id": "id",
          "name": "name"
        },
        "state": "available",
        "zone": "zone"
      }
    },
    "from_server": "from_server",
    "organization": "organization",
    "public": true,
    "root_volume": {
      "id": "id",
      "name": "name",
      "size": 0,
      "volume_type": "l_ssd"
    },
    "state": "available",
    "project": "project",
    "tags": [
      "string"
    ],
    "zone": "zone"
  }
}

json

application/json

Instances Security Groups