VPS

Enable rescue mode

post/vps/{vps_id}/rescue

Shut down your server and boot it into a rescue system to repair it. Its disk is not changed or mounted. Log in as root over SSH with the temporary password sent by email or your SSH keys, or use the console. Rescue mode stays on until you disable it.

Authorization

Authorization*string

Bearer YOUR_API_TOKEN with an API token. The X-API-Key: YOUR_API_TOKEN header works too.

Path parameters

vps_id*integer

Range1 ≤ value

Request body

Boot the server into the rescue system until you disable it.

A temporary root password is always created and sent by email to your organization. Fields of older versions (password_auth, duration_hours, new_password) are no longer read: requests that still send them keep working. To get a new password, exit and enter again.

application/jsonRequired

ssh_key_ids?array<integer>

SSH keys of your organization allowed to log in as root in the rescue system.

Rangeitems ≤ 50

Responses

Successful Response

application/json

detail*string

ip_addresses?array<string>

Addresses to reach the rescue system on.

ssh_firewall_warning*boolean

The server firewall does not allow inbound SSH (tcp/22), so only the console will work.

password_emailed*boolean

Whether a root password was emailed to your organization.