Snapshots

Download schema

Snapshots contain the data of a specified volume at a particular point in time. The data can include the Instance's operating system, configuration information and/or files stored on the volume.

A snapshot can be done from a specified volume, e.g. you have one Instance with a volume containing the OS and another one containing the application data, and you want to use different snapshot strategies on both volumes.

Volumes can be created from snapshots of their own type.

List snapshots

GET

https://api.scaleway.com

/instance/v1/zones/{zone}/snapshots

List all snapshots of an Organization in a specified Availability Zone.

List snapshots › 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 snapshots › query Parameters

organization

string

List snapshots only for this Organization ID.

project

string

List snapshots only for this Project ID.

per_page

integer · uint32

Number of snapshots returned per page (positive integer lower or equal to 100).

page

integer · int32

Page to be returned.

name

string

List snapshots of the requested name.

tags

string

List snapshots that have the requested tag.

base_volume_id

string

List snapshots originating only from this volume.

List snapshots › Responses

200

scaleway.instance.v1.ListSnapshotsResponse

scaleway.instance.v1.Snapshot[]

List of snapshots.

Create a snapshot from a specified volume or from a QCOW2 file

POST

https://api.scaleway.com

/instance/v1/zones/{zone}/snapshots

Create a snapshot from a specified volume or from a QCOW2 file in a specified Availability Zone.

Create a snapshot from a specified volume or from a QCOW2 file › 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 a snapshot from a specified volume or from a QCOW2 file › Request Body

name

string

Name of the snapshot.

volume_id

string

UUID of the volume.

tags

string[]

Tags of the snapshot.

project

string

Project ID of the snapshot.

volume_type

string · enum

Volume type of the snapshot. Overrides the volume_type of the snapshot. If omitted, the volume type of the original volume will be used.

Enum values:

unknown_volume_type

l_ssd

b_ssd

unified

Default: unknown_volume_type

bucket

string

Bucket name for snapshot imports.

key

string

Object key for snapshot imports.

size

integer · uint64

Imported snapshot size, must be a multiple of 512. (in bytes)

Create a snapshot from a specified volume or from a QCOW2 file › Responses

scaleway.instance.v1.CreateSnapshotResponse

scaleway.instance.v1.Snapshot

scaleway.instance.v1.Task

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

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string"}' \
  "https://api.scaleway.com/instance/v1/zones/{zone}/snapshots"

Example Request Body

{
  "name": "name",
  "volume_id": "volume_id",
  "tags": [
    "string"
  ],
  "organization": "organization",
  "project": "project",
  "volume_type": "unknown_volume_type",
  "bucket": "bucket",
  "key": "key",
  "size": 0
}

json

Example Responses

{
  "snapshot": {
    "id": "id",
    "name": "name",
    "organization": "organization",
    "project": "project",
    "tags": [
      "string"
    ],
    "volume_type": "l_ssd",
    "size": 0,
    "state": "available",
    "base_volume": {
      "id": "id",
      "name": "name"
    },
    "creation_date": "2022-03-22T12:34:56.123456Z",
    "modification_date": "2022-03-22T12:34:56.123456Z",
    "zone": "zone",
    "error_reason": "error_reason"
  },
  "task": {
    "id": "id",
    "description": "description",
    "progress": 0,
    "started_at": "2022-03-22T12:34:56.123456Z",
    "terminated_at": "2022-03-22T12:34:56.123456Z",
    "status": "pending",
    "href_from": "href_from",
    "href_result": "href_result",
    "zone": "zone"
  }
}

json

application/json

Get a snapshot

GET

https://api.scaleway.com

/instance/v1/zones/{zone}/snapshots/{snapshot_id}

Get details of a snapshot with the specified ID.

Get a snapshot › 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

snapshot_id

string · required

UUID of the snapshot you want to get.

Get a snapshot › Responses

200

scaleway.instance.v1.GetSnapshotResponse

scaleway.instance.v1.Snapshot

Set snapshot

PUT

https://api.scaleway.com

/instance/v1/zones/{zone}/snapshots/{snapshot_id}

Replace all the properties of a snapshot.

Set snapshot › 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

snapshot_id

string · required

Set snapshot › Request Body

id

string

name

string

organization

string

volume_type

scaleway.instance.v1.Volume.VolumeType · enum

Enum values:

l_ssd

b_ssd

unified

scratch

sbs_volume

sbs_snapshot

Default: l_ssd

size

integer · uint64

(in bytes)

state

scaleway.instance.v1.Snapshot.State · enum

Enum values:

available

snapshotting

error

invalid_data

importing

exporting

Default: available

scaleway.instance.v1.Snapshot.BaseVolume

creation_date

string · date-time

(RFC 3339 format)

modification_date

string · date-time

(RFC 3339 format)

project

string

tags

string[]

Set snapshot › Responses

200

scaleway.instance.v1.SetSnapshotResponse

scaleway.instance.v1.Snapshot

PUT/instance/v1/zones/{zone}/snapshots/{snapshot_id}

curl -X PUT \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "string",
    "name": "string",
    "organization": "string",
    "project": "string",
    "size": 42
  }' \
  "https://api.scaleway.com/instance/v1/zones/{zone}/snapshots/{snapshot_id}"

Example Request Body

{
  "id": "id",
  "name": "name",
  "organization": "organization",
  "volume_type": "l_ssd",
  "size": 0,
  "state": "available",
  "base_volume": {
    "id": "id",
    "name": "name"
  },
  "creation_date": "2022-03-22T12:34:56.123456Z",
  "modification_date": "2022-03-22T12:34:56.123456Z",
  "project": "project",
  "tags": [
    "string"
  ]
}

json

Example Responses

{
  "snapshot": {
    "id": "id",
    "name": "name",
    "organization": "organization",
    "project": "project",
    "tags": [
      "string"
    ],
    "volume_type": "l_ssd",
    "size": 0,
    "state": "available",
    "base_volume": {
      "id": "id",
      "name": "name"
    },
    "creation_date": "2022-03-22T12:34:56.123456Z",
    "modification_date": "2022-03-22T12:34:56.123456Z",
    "zone": "zone",
    "error_reason": "error_reason"
  }
}

json

application/json

Delete a snapshot

DELETE

https://api.scaleway.com

/instance/v1/zones/{zone}/snapshots/{snapshot_id}

Delete the snapshot with the specified ID.

Delete a snapshot › 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

snapshot_id

string · required

UUID of the snapshot you want to delete.

Delete a snapshot › Responses

No data returned

Update a snapshot

PATCH

https://api.scaleway.com

/instance/v1/zones/{zone}/snapshots/{snapshot_id}

Update the properties of a snapshot.

Update a snapshot › 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

snapshot_id

string · required

UUID of the snapshot. (UUID format)

Update a snapshot › Request Body

name

string

Name of the snapshot.

tags

string[]

Tags of the snapshot.

Update a snapshot › Responses

200

scaleway.instance.v1.UpdateSnapshotResponse

scaleway.instance.v1.Snapshot

PATCH/instance/v1/zones/{zone}/snapshots/{snapshot_id}

curl -X PATCH \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/instance/v1/zones/{zone}/snapshots/{snapshot_id}"

Example Request Body

{
  "name": "name",
  "tags": [
    "string"
  ]
}

json

Example Responses

{
  "snapshot": {
    "id": "id",
    "name": "name",
    "organization": "organization",
    "project": "project",
    "tags": [
      "string"
    ],
    "volume_type": "l_ssd",
    "size": 0,
    "state": "available",
    "base_volume": {
      "id": "id",
      "name": "name"
    },
    "creation_date": "2022-03-22T12:34:56.123456Z",
    "modification_date": "2022-03-22T12:34:56.123456Z",
    "zone": "zone",
    "error_reason": "error_reason"
  }
}

json

application/json

Export a snapshot

POST

https://api.scaleway.com

/instance/v1/zones/{zone}/snapshots/{snapshot_id}/export

Export a snapshot to a specified Object Storage bucket in the same region.

Export a snapshot › 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

snapshot_id

string · required

Snapshot ID.

Export a snapshot › Request Body

bucket

string

Object Storage bucket name.

key

string

Object key.

Export a snapshot › Responses

200

scaleway.instance.v1.ExportSnapshotResponse

scaleway.instance.v1.Task

Volumes Placement Groups

Instance API

Snapshots

Download schema

Snapshots contain the data of a specified volume at a particular point in time. The data can include the Instance's operating system, configuration information and/or files stored on the volume.

Volumes can be created from snapshots of their own type.

List snapshots

GET

https://api.scaleway.com

/instance/v1/zones/{zone}/snapshots

List all snapshots of an Organization in a specified Availability Zone.

List snapshots › 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 snapshots › query Parameters

organization

string

List snapshots only for this Organization ID.

project

string

List snapshots only for this Project ID.

per_page

integer · uint32

Number of snapshots returned per page (positive integer lower or equal to 100).

page

integer · int32

Page to be returned.

name

string

List snapshots of the requested name.

tags

string

List snapshots that have the requested tag.

base_volume_id

string

List snapshots originating only from this volume.

List snapshots › Responses

200

scaleway.instance.v1.ListSnapshotsResponse

scaleway.instance.v1.Snapshot[]

List of snapshots.

Create a snapshot from a specified volume or from a QCOW2 file

POST

https://api.scaleway.com

/instance/v1/zones/{zone}/snapshots

Create a snapshot from a specified volume or from a QCOW2 file in a specified Availability Zone.

Create a snapshot from a specified volume or from a QCOW2 file › 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 a snapshot from a specified volume or from a QCOW2 file › Request Body

name

string

Name of the snapshot.

volume_id

string

UUID of the volume.

tags

string[]

Tags of the snapshot.

project

string

Project ID of the snapshot.

volume_type

string · enum

Volume type of the snapshot. Overrides the volume_type of the snapshot. If omitted, the volume type of the original volume will be used.

Enum values:

unknown_volume_type

l_ssd

b_ssd

unified

Default: unknown_volume_type

bucket

string

Bucket name for snapshot imports.

key

string

Object key for snapshot imports.

size

integer · uint64

Imported snapshot size, must be a multiple of 512. (in bytes)

Create a snapshot from a specified volume or from a QCOW2 file › Responses

scaleway.instance.v1.CreateSnapshotResponse

scaleway.instance.v1.Snapshot

scaleway.instance.v1.Task

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

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string"}' \
  "https://api.scaleway.com/instance/v1/zones/{zone}/snapshots"

Example Request Body

{
  "name": "name",
  "volume_id": "volume_id",
  "tags": [
    "string"
  ],
  "organization": "organization",
  "project": "project",
  "volume_type": "unknown_volume_type",
  "bucket": "bucket",
  "key": "key",
  "size": 0
}

json

Example Responses

{
  "snapshot": {
    "id": "id",
    "name": "name",
    "organization": "organization",
    "project": "project",
    "tags": [
      "string"
    ],
    "volume_type": "l_ssd",
    "size": 0,
    "state": "available",
    "base_volume": {
      "id": "id",
      "name": "name"
    },
    "creation_date": "2022-03-22T12:34:56.123456Z",
    "modification_date": "2022-03-22T12:34:56.123456Z",
    "zone": "zone",
    "error_reason": "error_reason"
  },
  "task": {
    "id": "id",
    "description": "description",
    "progress": 0,
    "started_at": "2022-03-22T12:34:56.123456Z",
    "terminated_at": "2022-03-22T12:34:56.123456Z",
    "status": "pending",
    "href_from": "href_from",
    "href_result": "href_result",
    "zone": "zone"
  }
}

json

application/json

Get a snapshot

GET

https://api.scaleway.com

/instance/v1/zones/{zone}/snapshots/{snapshot_id}

Get details of a snapshot with the specified ID.

Get a snapshot › 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

snapshot_id

string · required

UUID of the snapshot you want to get.

Get a snapshot › Responses

200

scaleway.instance.v1.GetSnapshotResponse

scaleway.instance.v1.Snapshot

Set snapshot

PUT

https://api.scaleway.com

/instance/v1/zones/{zone}/snapshots/{snapshot_id}

Replace all the properties of a snapshot.

Set snapshot › 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

snapshot_id

string · required

Set snapshot › Request Body

id

string

name

string

organization

string

volume_type

scaleway.instance.v1.Volume.VolumeType · enum

Enum values:

l_ssd

b_ssd

unified

scratch

sbs_volume

sbs_snapshot

Default: l_ssd

size

integer · uint64

(in bytes)

state

scaleway.instance.v1.Snapshot.State · enum

Enum values:

available

snapshotting

error

invalid_data

importing

exporting

Default: available

scaleway.instance.v1.Snapshot.BaseVolume

creation_date

string · date-time

(RFC 3339 format)

modification_date

string · date-time

(RFC 3339 format)

project

string

tags

string[]

Set snapshot › Responses

200

scaleway.instance.v1.SetSnapshotResponse

scaleway.instance.v1.Snapshot

PUT/instance/v1/zones/{zone}/snapshots/{snapshot_id}

curl -X PUT \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "string",
    "name": "string",
    "organization": "string",
    "project": "string",
    "size": 42
  }' \
  "https://api.scaleway.com/instance/v1/zones/{zone}/snapshots/{snapshot_id}"

Example Request Body

{
  "id": "id",
  "name": "name",
  "organization": "organization",
  "volume_type": "l_ssd",
  "size": 0,
  "state": "available",
  "base_volume": {
    "id": "id",
    "name": "name"
  },
  "creation_date": "2022-03-22T12:34:56.123456Z",
  "modification_date": "2022-03-22T12:34:56.123456Z",
  "project": "project",
  "tags": [
    "string"
  ]
}

json

Example Responses

{
  "snapshot": {
    "id": "id",
    "name": "name",
    "organization": "organization",
    "project": "project",
    "tags": [
      "string"
    ],
    "volume_type": "l_ssd",
    "size": 0,
    "state": "available",
    "base_volume": {
      "id": "id",
      "name": "name"
    },
    "creation_date": "2022-03-22T12:34:56.123456Z",
    "modification_date": "2022-03-22T12:34:56.123456Z",
    "zone": "zone",
    "error_reason": "error_reason"
  }
}

json

application/json

Delete a snapshot

DELETE

https://api.scaleway.com

/instance/v1/zones/{zone}/snapshots/{snapshot_id}

Delete the snapshot with the specified ID.

Delete a snapshot › 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

snapshot_id

string · required

UUID of the snapshot you want to delete.

Delete a snapshot › Responses

No data returned

Update a snapshot

PATCH

https://api.scaleway.com

/instance/v1/zones/{zone}/snapshots/{snapshot_id}

Update the properties of a snapshot.

Update a snapshot › 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

snapshot_id

string · required

UUID of the snapshot. (UUID format)

Update a snapshot › Request Body

name

string

Name of the snapshot.

tags

string[]

Tags of the snapshot.

Update a snapshot › Responses

200

scaleway.instance.v1.UpdateSnapshotResponse

scaleway.instance.v1.Snapshot

PATCH/instance/v1/zones/{zone}/snapshots/{snapshot_id}

curl -X PATCH \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/instance/v1/zones/{zone}/snapshots/{snapshot_id}"

Example Request Body

{
  "name": "name",
  "tags": [
    "string"
  ]
}

json

Example Responses

{
  "snapshot": {
    "id": "id",
    "name": "name",
    "organization": "organization",
    "project": "project",
    "tags": [
      "string"
    ],
    "volume_type": "l_ssd",
    "size": 0,
    "state": "available",
    "base_volume": {
      "id": "id",
      "name": "name"
    },
    "creation_date": "2022-03-22T12:34:56.123456Z",
    "modification_date": "2022-03-22T12:34:56.123456Z",
    "zone": "zone",
    "error_reason": "error_reason"
  }
}

json

application/json

Export a snapshot

POST

https://api.scaleway.com

/instance/v1/zones/{zone}/snapshots/{snapshot_id}/export

Export a snapshot to a specified Object Storage bucket in the same region.

Export a snapshot › 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

snapshot_id

string · required

Snapshot ID.

Export a snapshot › Request Body

bucket

string

Object Storage bucket name.

key

string

Object key.

Export a snapshot › Responses

200

scaleway.instance.v1.ExportSnapshotResponse

scaleway.instance.v1.Task

Volumes Placement Groups