RArafftechnologies
Virtual Machines

Reset VM password

Changed on

Set a new root (Linux) or Administrator (Windows) password and email it to the account owner. On a running server Raff sets it in the server itself and the server confirms it, without a restart (result: set). A server Raff cannot reach that way gets it through its settings (result: applying): a running Linux server restarts to apply it, Windows takes it within about a minute, and a stopped server when it starts; message says which. If the server refuses the new password (for example its password policy), success is false, error gives the server's reason, and the old password still works.

post/api/v1/vms/{id}/reset-password

Request

  • Base URL
    https://api.rafftechnologies.com
  • URL
    https://api.rafftechnologies.com/api/v1/vms/{id}/reset-password
  • Auth
    API key in header X-API-Key

Path parameters

idstring uuid required

VM ID (UUID)

Headers

X-Project-IDstring uuid required

Project ID. Required for all mutating operations (create, delete, power actions, resize).

Response

The reset's outcome

successboolean
messagestring

Where the password went and when it takes effect.

result'set' | 'applying'

set: the server confirmed the new password. applying: it takes effect as message says.

errorstring

Why the password was not reset (only when success is false).

Example response

{
  "message": "Password reset successfully. New password sent to you@example.com. It works now, and your server did not restart."
}

Changes