docs(ins): update snapshot documentation

bene2k1 · bene2k1 · commit 95ee9ae4cf28 · 2025-05-28T11:06:04.000+02:00
diff --git a/pages/instances/api-cli/managing-instance-snapshot-via-cli.mdx b/pages/instances/api-cli/managing-instance-snapshot-via-cli.mdx
@@ -7,7 +7,7 @@ content:
   paragraph: This page explains how to manage Scaleway Instance snapshots with the CLI (v2)
 tags: manage instance snapshot cli cli-v2
 dates:
-  validation: 2025-04-22
+  validation: 2025-05-28
   posted: 2022-09-24
 categories:
   - compute
@@ -38,15 +38,11 @@ The following arguments and flags are available to customize your command:
 
 ```sh
 ARGS:
+  [volume-id]          UUID of the volume to snapshot
   [name=<generated>]   Name of the snapshot
-  [volume-id]          UUID of the volume
-  [tags.{index}]       The tags of the snapshot
   [project-id]         Project ID to use. If none is passed the default project ID will be used
-  [bucket]             Bucket name for snapshot imports
-  [key]                Object key for snapshot imports
-  [size]               Imported snapshot size, must be a multiple of 512
-  [organization-id]    Organization ID to use. If none is passed the default organization ID will be used
-  [zone=fr-par-1]      Zone to target. If none is passed will use the default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | pl-waw-1)
+  [tags.{index}]       List of tags assigned to the snapshot
+  [zone=fr-par-1]      Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | nl-ams-3 | pl-waw-1 | pl-waw-2 | pl-waw-3)
 
 FLAGS:
   -h, --help   help for create
@@ -82,11 +78,21 @@ Run the following command to create a named snapshot from the given volume ID. R
 scw block snapshot create name=foobar volume-id=11111111-1111-1111-1111-111111111111
 ```
 
+## Exporting a QCOW file to an Object Storage bucket from an Instance snapshot
+
+Run the following command to export an Instance snapshot as a QCOW2 file to an existing Object Storage bucket in the same geographical region as the snapshot.
+
+```
+scw block snapshot export-to-object-storage zone=fr-par-1 snapshot-id=11111111-1111-1111-1111-111111111111 bucket=<my-bucket> key=<my-qcow2-file-name.qcow2>
+```
+
 ## Importing a QCOW file from an Object Storage bucket as Instance snapshot
 
-Run the following command to import a QCOW file as an Instance snapshot. Replace the bucket name `my-bucket` with the name of your Object Storage bucket and the file name `qcow2-file-name.qcow2` with the name of your QCOW file.
+Run the following command to import a QCOW file as an Instance snapshot. Replace the snapshot name `my-imported-snapshot` with the name of the snapshot to create, the bucket name `my-bucket` with the name of your Object Storage bucket and the file name `my-qcow2-file-name.qcow2` with the name of your QCOW file.
+Specify the size of the imoported snapshot with the `size=10GB` flag.
+
 ```
-scw block snapshot create zone=fr-par-1 name=my-imported-snapshot volume-type=b_ssd bucket=my-bucket key=my-qcow2-file-name.qcow
+scw block snapshot import-from-object-storage zone=fr-par-1 name=<my-imported-snapshot> bucket=<my-bucket> key=<my-qcow2-file-name.qcow2> size=10GB
 ```
 
 <Message type="important">
diff --git a/pages/instances/api-cli/snapshot-import-export-feature.mdx b/pages/instances/api-cli/snapshot-import-export-feature.mdx
@@ -7,7 +7,7 @@ content:
   paragraph: This page explains how to import/export Instance snapshots using the Scaleway API
 tags: snapshot import export api instance
 dates:
-  validation: 2025-03-03
+  validation: 2025-05-28
   posted: 2021-07-25
 categories:
   - compute
@@ -43,30 +43,39 @@ More information on the QCOW2 file format, and how to use it can be found in the
 
     For example, using curl:
     ```sh
-    curl -X POST https://api.scaleway.com/instance/v1/zones/fr-par-1/snapshots/<snapshot_uuid>/export \
-    -H "X-Auth-Token: <secret_key>" \
-    -H "Content-Type: application/json" \
-    --data '{"bucket": "my-bucket", "key": "my-exported-snapshot.qcow2"}'
-      ```
-    The following information is required to run the command above: 
-      - The Availability Zone of the snapshot (here: `fr-par-1`)
+    curl -X POST \
+      -H "X-Auth-Token: $SCW_SECRET_KEY" \
+      -H "Content-Type: application/json" \
+      -d '{"bucket":"<my-bucket-name>","key":"<my-snapshot.qcow2>"}' \
+      "https://api.scaleway.com/block/v1/zones/<fr-par-1>/snapshots/<snapshot_id>/export-to-object-storage"
+    ```
+    The following information is required to run the command above:
+      - The Availability Zone of the snapshot (for example: `fr-par-1`)
       - The secret key of your API key pair (`<secret_key>`)
-      - The snapshot ID (`<snapshot_uuid>`)
+      - The snapshot ID (`<snapshot_id>`)
       - The name of the Object Storage bucket to store the snapshot (which has to exist in the same Scaleway region as the snapshot)
       - A key (can be any acceptable key/object name for Scaleway Object Storage (suffixing qcow2 images with `.qcow2`))
 
     The API returns an output as in the following example:
     ```json
     {
-    "task": {
-        "id": "<task_uuid>",
-        "description": "export_snapshot",
-        "status": "pending",
-        "href_from": "/snapshots/<snapshot_uuid>/export",
-        "href_result": "https://s3.fr-par.scw.cloud/my-bucket/my-exported-snapshot.qcow2",
-        "started_at": "2022-07-25T15:23:49.278630+00:00",
-        "terminated_at": null
-    }
+        "id": "939d0c67-2f82-4bd6-a9d0-94dd36c6d888",
+        "name": "<my-snapshot-name>>",
+        "parent_volume": {
+            "id": "9e17baf7-1316-490b-964f-dd76ac7f5e93",
+            "name": "<my-snapshot.qcow2>",
+            "type": "sbs_5k",
+            "status": "in_use"
+        },
+        "size": 10000000000,
+        "project_id": "c1d1dab1-7e1a-4744-b0fd-d5a80ede56e4",
+        "created_at": "2025-05-28T08:07:22.599534Z",
+        "updated_at": "2025-05-28T08:07:22.599534Z",
+        "references": [],
+        "status": "exporting",
+        "tags": [],
+        "class": "sbs",
+        "zone": "fr-par-1"
     }
     ```
 
@@ -83,62 +92,50 @@ Call the `import` snapshot API endpoint to initiate the snapshot import.
 For example, using curl:
 
 ```sh
-curl -X POST https://api.scaleway.com/instance/v1/zones/fr-par-2/snapshots/ \
--H "X-Auth-Token: <secret_key>" -H "Content-Type: application/json" \
---data '{"bucket": "my-bucket", "key": "my-exported-snapshot.qcow2", "volume_type": "b_ssd", "project": "<scaleway_project_id>", "name": "my-imported-snapshot"}'
+curl -X POST \
+  -H "X-Auth-Token: $SCW_SECRET_KEY" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "bucket": "<my-bucket-name>",
+    "key": "<my-snapshot.qcow2>",
+    "name": "<my-imported-snapshot>",
+    "project_id": "<my-project-id>",
+    "size": "<snapshot-size-in-bytes>"
+  }' \
+  "https://api.scaleway.com/block/v1/zones/fr-par-1/snapshots/import-from-object-storage"
 ```
 
 The following information is required to run the command above:
-  - The Availability Zone of the snapshot (here: `fr-par-2`)
-  - The secret key of your API key pair (`<secret_key>`)
+  - The Availability Zone of the snapshot (here: `fr-par-1`)
   - The name of the Object Storage bucket holding the snapshot (which has to exist in the same Scaleway region as the snapshot)
   - The object name of the QCOW2 image
-
-  - The snapshot's volume type (It can be `l_ssd` or `b_ssd`.)
-  - A Scaleway Project UUID
   - The name of the newly created snapshot (used to identify the snapshot in the Console)
-  - **Optional**: A size parameter. If missing, the size of the created snapshot is defaulted to the QCOW2's volume size.
+  - A Scaleway Project UUID
+  - **Optional**: A size parameter in bytes. If missing, the size of the created snapshot is defaulted to the QCOW2's volume size.
 
 The API returns an output as in the following example:
 
 ```json
 {
-"snapshot": {
-    "id": "<snapshot_uuid>",
-    "name": "my-imported-snapshot",
-    "volume_type": "b_ssd",
-    "creation_date": "2022-07-25T15:27:48.654782+00:00",
-    "modification_date": "2022-07-25T15:27:48.654782+00:00",
-    "organization": "<scaleway_organization_id>",
-    "project": "<scaleway_project_id>",
+    "id": "033d6442-784b-4301-bfaa-0892973c296f",
+    "name": "<my-imported-snapshot>",
+    "parent_volume": null,
     "size": 10737418240,
-    "state": "importing",
-    "base_volume": null,
+    "project_id": "844e1e32-6280-42e2-aa96-45d3af1a1aea",
+    "created_at": "2025-05-28T08:35:53.199253Z",
+    "updated_at": "2025-05-28T08:35:53.199253Z",
+    "references": [],
+    "status": "creating",
     "tags": [],
-    "zone": "fr-par-2",
-    "error_details": null
-},
-"task": {
-    "id": "<task_uuid>",
-    "description": "import_snapshot",
-    "status": "pending",
-    "href_from": "/snapshots/",
-    "href_result": "snapshots/<snapshot_uuid>",
-    "started_at": "2022-07-25T15:27:48.797883+00:00",
-    "terminated_at": null
-}
+    "class": "sbs",
+    "zone": "fr-par-1"
 }
 ```
 
-Once the snapshot has been imported, it becomes available in the list of snapshots in the `fr-par-2` AZ:
+Once the snapshot has been imported, it becomes available in the list of snapshots in the `fr-par-1` AZ.
 
 <Message type="tip">
-  The Instance snapshot will be created as soon as the API call returns, but the import action will take several minutes to complete. In the meantime, the snapshot will be in the `importing` state, before becoming `available` once the import is successful.
-
-  ```sh
-  curl -X GET https://api.scaleway.com/instance/v1/zones/fr-par-2/snapshots/<snapshot_uuid> \
-    -H "X-Auth-Token: <secret_key>"  | jq ".snapshot.state" "importing"
-  ```
+  The Instance snapshot will be created as soon as the API call returns, but the import action will take several minutes to complete. In the meantime, the snapshot will be in the `creating` state, before becoming `available` once the import is successful.
 </Message>
 
 
diff --git a/pages/instances/how-to/create-image-from-snapshot.mdx b/pages/instances/how-to/create-image-from-snapshot.mdx
@@ -22,7 +22,7 @@ categories:
 
 ## Creating an image from a snapshot via the Scaleway console
 
-1. Click **CPU Instances** in the **Compute** section of the side menu. The [Instances page](https://console.scaleway.com/instance/servers) displays.
+1. Click **CPU & GPU Instances** in the **Compute** section of the side menu. The [Instances page](https://console.scaleway.com/instance/servers) displays.
 2. Click the **Images** tab. A list of your images displays.
 3. Click **+ Create image**. The image creation page displays.
 4. Choose the **Availability Zone** in which you want your image to be created.
@@ -50,10 +50,23 @@ scw instance image create snapshot-id="$SCW_VOLUME_ID_1" additional-volumes.0.id
 - Ensure the architecture (`arch`) is set to a valid value (e.g., `x86_64`).
 
 <Message type="note">
-  Supported volume IDs include:
-  - Local Storage volumes (`l_ssd`)
-  - Block Storage Low Latency volumes (`sbs`)
-  - Block Storage legacy (`b_ssd`) volumes (deprecated).
+  Supported arguments for the image create commmand include:
+  ```
+  ARGS:
+  [name=<generated>]                         Name of the image
+  snapshot-id                                UUID of the snapshot that will be used as root volume in the image
+  arch                                       Architecture of the image (unknown_arch | x86_64 | arm | arm64)
+  [additional-volumes.{index}.id]            UUID of the snapshot to add
+  [additional-volumes.{index}.name]          Name of the additional snapshot
+  [additional-volumes.{index}.size]          Size of the additional snapshot
+  [additional-volumes.{index}.volume-type]   Underlying volume type of the additional snapshot (l_ssd | b_ssd | unified | scratch | sbs_volume | sbs_snapshot)
+  [additional-volumes.{index}.project-id]    Project ID that own the additional snapshot
+  [project-id]                               Project ID to use. If none is passed the default project ID will be used
+  [tags.{index}]                             Tags of the image
+  [public]                                   True to create a public image
+  [organization-id]                          Organization ID to use. If none is passed the default organization ID will be used
+  [zone=fr-par-1]                            Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | nl-ams-3 | pl-waw-1 | pl-waw-2 | pl-waw-3)
+  ```
 </Message>
 
 ## Creating an image via the Scaleway API
diff --git a/pages/instances/how-to/snapshot-import-export-feature.mdx b/pages/instances/how-to/snapshot-import-export-feature.mdx
@@ -7,7 +7,7 @@ content:
   paragraph: This page explains how to import/export snapshots of Instances using the Scaleway console.
 tags: snapshot, import, export, instance, availability zone, qcow2
 dates:
-  validation: 2025-03-25
+  validation: 2025-05-28
   posted: 2021-07-27
 categories:
   - compute
@@ -33,7 +33,7 @@ More information on the QCOW2 file format and how to use it can be found in the
 For this guide, we assume you have an Instance running in the `fr-par-1` AZ, your Object Storage bucket is located in the region `fr-par`, and you want to create a new Instance in the `fr-par-2` AZ.
 </Message>
 
-1. Click the [Instances section](https://console.scaleway.com/instance/servers) of the Scaleway console, then click the Instance you want to snapshot.
+1. Click the [CPU & GPU Instances section](https://console.scaleway.com/instance/servers) of the Scaleway console, then click the Instance you want to snapshot.
 2. The Instance overview displays. Click the **Storage** tab to display the storage resources attached to the Instance. Scroll to the **Snapshots** section of the page.
 3. Click the name of the snapshot you want to export. The snapshot overview displays.
 4. Click **Actions** then select **Copy to bucket**. A pop-up displays. Enter the file name for your exported snapshot copy and select the destination bucket. Then click **Copy snapshot to bucket**.
@@ -45,7 +45,7 @@ For this guide, we assume you have an Instance running in the `fr-par-1` AZ, you
     Depending on the size of your snapshot, the export to Object Storage may take some time. It is ready once the status indicator changes to green.
     </Message>
 2. Click <Icon name="more" /> next to the snapshot copy, then click **Import as snapshot**. A pop-up will appear. Enter the name of the snapshot, select the destination AZ, and choose the snapshot type.
-    The type can be either **Local SSD** or **Block SSD**. Click **Import file as snapshot** to import the snapshot into the destination AZ.
+    The type can be either **Local Storage** or **Block Storage**. Click **Import object as snapshot** to import the snapshot into the destination AZ.
     <Message type="important">
       - Ensure that the QCOW / QCOW2 image file you want to import uses the file extension `.qcow` or `.qcow2` to avoid issues during import.
       - Imported snapshots must have a volume size between 1 GB and 1 TB.
