Linode Instances
Linode Boot into Rescue Mode
https://api.linode.com/v4/linode/instances/{linodeId}/rescue
Rescue Mode is a safe environment for performing many system recovery and disk management tasks. Rescue Mode is based on the Finnix recovery distribution, a self-contained and bootable Linux distribution. You can also use Rescue Mode for tasks other than disaster recovery, such as formatting disks to use different filesystems, copying data between disks, and downloading files from a disk via SSH and SFTP.
- Note that "sdh" is reserved and unavailable during rescue.
Path Parameters
ID of the Linode to rescue.
Request Body Schema
Device can be either a Disk or Volume identified by disk_id
or volume_id
. Only one type per slot allowed. Can be null.
Devices mapped from sde through sdh are unavailable in fullvirt
virt_mode.
The Disk ID, or null
if a Volume is assigned to this slot.
The Volume ID, or null
if a Disk is assigned to this slot.
Device can be either a Disk or Volume identified by disk_id
or volume_id
. Only one type per slot allowed. Can be null.
Devices mapped from sde through sdh are unavailable in fullvirt
virt_mode.
The Disk ID, or null
if a Volume is assigned to this slot.
The Volume ID, or null
if a Disk is assigned to this slot.
Device can be either a Disk or Volume identified by disk_id
or volume_id
. Only one type per slot allowed. Can be null.
Devices mapped from sde through sdh are unavailable in fullvirt
virt_mode.
The Disk ID, or null
if a Volume is assigned to this slot.
The Volume ID, or null
if a Disk is assigned to this slot.
Device can be either a Disk or Volume identified by disk_id
or volume_id
. Only one type per slot allowed. Can be null.
Devices mapped from sde through sdh are unavailable in fullvirt
virt_mode.
The Disk ID, or null
if a Volume is assigned to this slot.
The Volume ID, or null
if a Disk is assigned to this slot.
Device can be either a Disk or Volume identified by disk_id
or volume_id
. Only one type per slot allowed. Can be null.
Devices mapped from sde through sdh are unavailable in fullvirt
virt_mode.
The Disk ID, or null
if a Volume is assigned to this slot.
The Volume ID, or null
if a Disk is assigned to this slot.
Device can be either a Disk or Volume identified by disk_id
or volume_id
. Only one type per slot allowed. Can be null.
Devices mapped from sde through sdh are unavailable in fullvirt
virt_mode.
The Disk ID, or null
if a Volume is assigned to this slot.
The Volume ID, or null
if a Disk is assigned to this slot.
Device can be either a Disk or Volume identified by disk_id
or volume_id
. Only one type per slot allowed. Can be null.
Devices mapped from sde through sdh are unavailable in fullvirt
virt_mode.
The Disk ID, or null
if a Volume is assigned to this slot.
The Volume ID, or null
if a Disk is assigned to this slot.
Request Samples
- Shell
- CLI
curl -H "Content-Type: application/json" \
-H "Authorization: Bearer $TOKEN" \
-X POST -d '{
"devices": {
"sda": {
"disk_id": 124458,
"volume_id": null
},
"sdb": {
"disk_id": null,
"volume_id": null
}
}
}' \
https://api.linode.com/v4/linode/instances/123/rescue
Response Samples
- 200
- default
{}
Responses
200: Rescue started.
default: Error
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.
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.