Snapshots

Download schema

Snapshots contain the data of a specified l_ssd 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.

l_ssd volumes can be created from snapshots.

List snapshots

GET

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/snapshots

List all snapshots of an Organization.

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

project_id

string · required

Filter by Project ID.

page_token

string

Token for pagination.

page_size

integer · uint32

Number of snapshots to return per page.

order_by

scaleway.instance.v2alpha1.ListSnapshotsRequest.OrderBy · enum

Field to sort by.

Enum values:

created_at_desc

created_at_asc

updated_at_desc

updated_at_asc

Default: created_at_desc

snapshot_ids

string[]

Filter by specific snapshot IDs.

name

string

Filter by name.

tags

string[]

Filter by tags.

base_volume_id

string

Filter by base volume ID.

List snapshots › Responses

200

scaleway.instance.v2alpha1.ListSnapshotsResponse

scaleway.instance.v2alpha1.Snapshot[]

List of snapshots.

next_page_token

string | null

Token for the next page.

total_count

integer · uint64

Total number of items.

Create a snapshot from a specified volume

POST

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/snapshots

Create a snapshot from a specified l_ssd volume.

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

project_id

string

Project ID of the snapshot.

name

string

Name of the snapshot.

tags

string[]

Tags associated with the snapshot.

base_volume_id

string

ID of the base volume.

public

boolean

Whether the snapshot should be public.

Create a snapshot from a specified volume › Responses

200

scaleway.instance.v2alpha1.Snapshot

id

string

Unique ID of the snapshot.

srn

string

The SRN of the snapshot.

project_id

string

Project ID of the snapshot.

name

string

Name of the snapshot.

tags

string[]

Tags associated with the snapshot.

size

integer · uint64

Size of the snapshot in bytes. (in bytes)

status

scaleway.instance.v2alpha1.Snapshot.Status · enum

Current status of the snapshot.

Enum values:

unknown_status

available

creating

error

invalid_data

exporting

Default: unknown_status

base_volume_id

string | null

ID of the base volume.

volume_type

scaleway.instance.v2alpha1.Snapshot.VolumeType · enum

Type of the volume.

Enum values:

unknown_volume_type

l_ssd

Default: unknown_volume_type

created_at

string | null · date-time

Creation date of the snapshot. (RFC 3339 format)

updated_at

string | null · date-time

Last update date of the snapshot. (RFC 3339 format)

zone

string

Zone in which the snapshot is located.

public

boolean

Whether the snapshot is public.

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

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

Example Request Body

{
  "project_id": "project_id",
  "name": "name",
  "tags": [
    "string"
  ],
  "base_volume_id": "base_volume_id",
  "public": true
}

json

Example Responses

{
  "id": "id",
  "srn": "srn",
  "project_id": "project_id",
  "name": "name",
  "tags": [
    "string"
  ],
  "size": 0,
  "status": "unknown_status",
  "base_volume_id": "base_volume_id",
  "volume_type": "unknown_volume_type",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "zone": "zone",
  "public": true
}

json

application/json

Get a snapshot

GET

https://api.scaleway.com

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

Get details of a specified snapshot.

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

ID of the snapshot to retrieve.

Get a snapshot › Responses

200

scaleway.instance.v2alpha1.Snapshot

id

string

Unique ID of the snapshot.

srn

string

The SRN of the snapshot.

project_id

string

Project ID of the snapshot.

name

string

Name of the snapshot.

tags

string[]

Tags associated with the snapshot.

size

integer · uint64

Size of the snapshot in bytes. (in bytes)

status

scaleway.instance.v2alpha1.Snapshot.Status · enum

Current status of the snapshot.

Enum values:

unknown_status

available

creating

error

invalid_data

exporting

Default: unknown_status

base_volume_id

string | null

ID of the base volume.

volume_type

scaleway.instance.v2alpha1.Snapshot.VolumeType · enum

Type of the volume.

Enum values:

unknown_volume_type

l_ssd

Default: unknown_volume_type

created_at

string | null · date-time

Creation date of the snapshot. (RFC 3339 format)

updated_at

string | null · date-time

Last update date of the snapshot. (RFC 3339 format)

zone

string

Zone in which the snapshot is located.

public

boolean

Whether the snapshot is public.

Delete a snapshot

DELETE

https://api.scaleway.com

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

Delete a specified snapshot.

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

ID of the snapshot to delete.

Delete a snapshot › Responses

No data returned

Update a snapshot

PATCH

https://api.scaleway.com

/instance/v2alpha1/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

ID of the snapshot to update.

Update a snapshot › Request Body

name

string | null

New name for the snapshot.

tags

array | null

New tags for the snapshot.

public

boolean | null

Whether the snapshot should be public.

Update a snapshot › Responses

200

scaleway.instance.v2alpha1.Snapshot

id

string

Unique ID of the snapshot.

srn

string

The SRN of the snapshot.

project_id

string

Project ID of the snapshot.

name

string

Name of the snapshot.

tags

string[]

Tags associated with the snapshot.

size

integer · uint64

Size of the snapshot in bytes. (in bytes)

status

scaleway.instance.v2alpha1.Snapshot.Status · enum

Current status of the snapshot.

Enum values:

unknown_status

available

creating

error

invalid_data

exporting

Default: unknown_status

base_volume_id

string | null

ID of the base volume.

volume_type

scaleway.instance.v2alpha1.Snapshot.VolumeType · enum

Type of the volume.

Enum values:

unknown_volume_type

l_ssd

Default: unknown_volume_type

created_at

string | null · date-time

Creation date of the snapshot. (RFC 3339 format)

updated_at

string | null · date-time

Last update date of the snapshot. (RFC 3339 format)

zone

string

Zone in which the snapshot is located.

public

boolean

Whether the snapshot is public.

Export a snapshot to Object Storage

POST

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/snapshots/{snapshot_id}/export-to-object-storage

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

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

ID of the snapshot to export.

Export a snapshot to Object Storage › Request Body

bucket

string

Object Storage bucket name.

object_key

string

Object key.

Export a snapshot to Object Storage › Responses

200

scaleway.instance.v2alpha1.Snapshot

id

string

Unique ID of the snapshot.

srn

string

The SRN of the snapshot.

project_id

string

Project ID of the snapshot.

name

string

Name of the snapshot.

tags

string[]

Tags associated with the snapshot.

size

integer · uint64

Size of the snapshot in bytes. (in bytes)

status

scaleway.instance.v2alpha1.Snapshot.Status · enum

Current status of the snapshot.

Enum values:

unknown_status

available

creating

error

invalid_data

exporting

Default: unknown_status

base_volume_id

string | null

ID of the base volume.

volume_type

scaleway.instance.v2alpha1.Snapshot.VolumeType · enum

Type of the volume.

Enum values:

unknown_volume_type

l_ssd

Default: unknown_volume_type

created_at

string | null · date-time

Creation date of the snapshot. (RFC 3339 format)

updated_at

string | null · date-time

Last update date of the snapshot. (RFC 3339 format)

zone

string

Zone in which the snapshot is located.

public

boolean

Whether the snapshot is public.

POST/instance/v2alpha1/zones/{zone}/snapshots/{snapshot_id}/export-to-object-storage

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"bucket":"string","object_key":"string"}' \
  "https://api.scaleway.com/instance/v2alpha1/zones/{zone}/snapshots/{snapshot_id}/export-to-object-storage"

Example Request Body

{
  "bucket": "bucket",
  "object_key": "object_key"
}

json

Example Responses

{
  "id": "id",
  "srn": "srn",
  "project_id": "project_id",
  "name": "name",
  "tags": [
    "string"
  ],
  "size": 0,
  "status": "unknown_status",
  "base_volume_id": "base_volume_id",
  "volume_type": "unknown_volume_type",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "zone": "zone",
  "public": true
}

json

application/json

Import a snapshot from Object Storage

POST

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/snapshots/import-from-object-storage

Import a snapshot from a QCOW2 file stored in Object Storage.

Import a snapshot from Object Storage › 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

Import a snapshot from Object Storage › Request Body

project_id

string

Project ID of the snapshot.

name

string

Name of the snapshot.

tags

string[]

Tags associated with the snapshot.

bucket

string

Object Storage bucket name.

object_key

string

Object key.

size

integer | null · uint64

Size of the imported snapshot in bytes. (in bytes)

volume_type

scaleway.instance.v2alpha1.Snapshot.VolumeType · enum

Volume type of the snapshot.

Enum values:

unknown_volume_type

l_ssd

Default: unknown_volume_type

Import a snapshot from Object Storage › Responses

200

scaleway.instance.v2alpha1.Snapshot

id

string

Unique ID of the snapshot.

srn

string

The SRN of the snapshot.

project_id

string

Project ID of the snapshot.

name

string

Name of the snapshot.

tags

string[]

Tags associated with the snapshot.

size

integer · uint64

Size of the snapshot in bytes. (in bytes)

status

scaleway.instance.v2alpha1.Snapshot.Status · enum

Current status of the snapshot.

Enum values:

unknown_status

available

creating

error

invalid_data

exporting

Default: unknown_status

base_volume_id

string | null

ID of the base volume.

volume_type

scaleway.instance.v2alpha1.Snapshot.VolumeType · enum

Type of the volume.

Enum values:

unknown_volume_type

l_ssd

Default: unknown_volume_type

created_at

string | null · date-time

Creation date of the snapshot. (RFC 3339 format)

updated_at

string | null · date-time

Last update date of the snapshot. (RFC 3339 format)

zone

string

Zone in which the snapshot is located.

public

boolean

Whether the snapshot is public.

POST/instance/v2alpha1/zones/{zone}/snapshots/import-from-object-storage

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "bucket": "string",
    "name": "string",
    "object_key": "string",
    "project_id": "string"
  }' \
  "https://api.scaleway.com/instance/v2alpha1/zones/{zone}/snapshots/import-from-object-storage"

Example Request Body

{
  "project_id": "project_id",
  "name": "name",
  "tags": [
    "string"
  ],
  "bucket": "bucket",
  "object_key": "object_key",
  "size": 0,
  "volume_type": "unknown_volume_type"
}

json

Example Responses

{
  "id": "id",
  "srn": "srn",
  "project_id": "project_id",
  "name": "name",
  "tags": [
    "string"
  ],
  "size": 0,
  "status": "unknown_status",
  "base_volume_id": "base_volume_id",
  "volume_type": "unknown_volume_type",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "zone": "zone",
  "public": true
}

json

application/json

Volumes