Linode Instances

Restore Backup

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

Restores a Linode's Backup to the specified Linode.

Authorizations

Personal Access Token
OAuth: ( linodes:read_write)

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.