Jump toSuggest an edit

Creating backups of Instances via the Scaleway API

Reviewed on 18 December 2023Published on 26 May 2021

The Backup feature is used to back up your Instance data. It creates an image of a snapshot that contains all your volumes. You can create backups of your Instances using either the Scaleway CLI tool or the Instances API.

Before you start

To complete the actions presented below, you must have:

  • A Scaleway account logged into the console
  • Owner status or IAM permissions allowing you to perform actions in the intended Organization
  • A valid API key

Creating a backup

Use the following commands to create a backup of your Instance using the Scaleway CLI.

scw instance server backup server-id zone=fr-par-1
  • Replace server-id with the unique identifier of the Instance.
  • Replace fr-par-1 with the Availability Zone your Instance is deployed in.

By default, the name of the image is built according to the name of the server and the date. You can specify a name for the image in the request:

scw instance server backp server-id zone=fr-par-1 name=myimagename

A backup request will create an image object. You can view it using:

scw instance image get image-uid zone=fr-par-1

An image contains one snapshot for each volume of the Instance. These snapshots are visible within the image response as root_volume and extra_volumes fields.

Deleting a Backup

To delete a backup, run the following command:

scw instance image delete image-uid zone=fr-par1

It is also recommended to remove every snapshot related to the image by running the following command for each snapshot that is no longer needed:

scw instance snapshot delete snapshot-uid zone=fr-par-1
Docs APIScaleway consoleDedibox consoleScaleway LearningScaleway.comPricingBlogCarreer
© 2023-2024 – Scaleway