RArafftechnologies
Virtual Machines

Set console access policy

Changed on

Toggle whether the VM's web console (terminal or VNC) asks for a fresh two-factor code before it opens. Off by default. When on, the dashboard prompts for the authenticator code (a confirmation unlocks protected consoles for 1 hour), and API keys cannot open the console. Which members may open the console at all is governed by the vm.console permission.

patch/api/v1/vms/{id}/console-policy

Request

  • Base URL
    https://api.rafftechnologies.com
  • URL
    https://api.rafftechnologies.com/api/v1/vms/{id}/console-policy
  • 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).

Request body

console_require_mfaboolean required

Require a two-factor-verified session to open the web console

Response

Console policy updated

successboolean
messagestring

Example response

{
  "success": true,
  "message": "Operation completed successfully"
}

Changes