View All Products
Compute
Storage
Databases
Networking
Developer Tools
Delivery
Security
Services
Industries
Pricing
Community
Engage With Us
Linode API 4.163.0

Endpoints

Linode Instances

Backup Restore

post
https://api.linode.com/v4/linode/instances/{linodeId}/backups/{backupId}/restore

Restores a Linode's Backup to the specified Linode.

The following conditions apply:

  • Backups may not be restored across Regions.
  • Only successfully completed Backups that are not undergoing maintenance can be restored.
  • The Linode that the Backup is being restored to must not itself be in the process of creating a Backup.

{{< note type="warning" title="Warning: UUID Collisions">}} When you restore a backup, the restored disk is assigned the same UUID as the original disk. In most cases, this is acceptable and does not cause issues. However, if you attempt to mount both the original disk and the corresponding restore disk at the same time (by assigning them both to devices in your Configuration Profile's Block Device Assignment), you will encounter a UUID "collision".

When this happens, the system selects, and mounts, only one of the disks at random. This is due to both disks sharing the same UUID, and your instance may fail to boot since it will not be clear which disk is root. If your system does boot, you will not see any immediate indication if you are booted into the restored disk or the original disk, and you will be unable to access both disks at the same time.

To avoid this, we recommend only restoring a backup to the same Compute Instance if you do not intend on mounting them at the same time or are comfortable modifying UUIDs. If you need access to files on both the original disk and the restored disk simultaneously (such as needing to copy files between them), we suggest either restoring the backup to a separate Compute Instance or creating a new Compute Instance with the desired backup_id.

To learn more about block device assignments and viewing your disks' UUIDs, see our guide on Configuration Profiles. {{< /note >}}

Path Parameters

linodeId
Required
integer

The ID of the Linode that the Backup belongs to.

backupId
Required
integer

The ID of the Backup to restore.

Request Body Schema

linode_id
Required
integer

The ID of the Linode to restore a Backup to.

overwrite
boolean

If True, deletes all Disks and Configs on the target Linode before restoring.

If False, and the Disk image size is larger than the available space on the Linode, an error message indicating insufficient space is returned.

Request Samples

curl -H "Content-Type: application/json" \
    -H "Authorization: Bearer $TOKEN" \
    -X POST -d '{
      "linode_id": 234,
      "overwrite": true
    }' \
    https://api.linode.com/v4/linode/instances/123/backups/123456/restore

Response Samples

{}

Responses

200: Restore from Backup was initiated.

default: Error

errors
array of objects
reason
string

What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.

field
string

The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as "null" if the error is not specific to any single element of the request.