v52

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-03269339953.6 KB
VPS: Recovery

Start recovery mode

Initiate recovery mode for a specified virtual machine.

Recovery mode is a special state that allows users to perform system rescue operations, such as repairing file systems, recovering data, or troubleshooting issues that prevent the virtual machine from booting normally.

Virtual machine will boot recovery disk image and original disk image will be mounted in /mnt directory.

Use this endpoint to enable system rescue operations on VPS instances.

post/api/vps/v1/virtual-machines/{virtualMachineId}/recovery

Path parameters

virtualMachineIdinteger required
Example:1268054

Virtual Machine ID

Request body

root_passwordstring required

Temporary root password for recovery mode

Example request

{
  "root_password": "oMeNRustosIO"
}

Response

Success response

idinteger

Action ID

namestring

Action name

state'success' | 'error' | 'delayed' | 'sent' | 'created'

Action state

created_atstring date-time
updated_atstring date-time

Example response

{
  "id": 8123712,
  "name": "action_name",
  "state": "success",
  "created_at": "2025-02-27T11:54:00Z",
  "updated_at": "2025-02-27T11:58:00Z"
}