Change VM Console Status

Change VM Console Status by enabling or disabling it.
  • • Console gives direct access to the VM's screen and input.
  • • It's useful for installing, troubleshooting, or recovering a VM without relying on remote access services like SSH or RDP.
You will need first to: Notes:
  • • Enabling the console reduces the security of the VM, and it also consumes additional resources and may introduce a small performance overhead
  • • Changing the VM console status will force a VM restart
To get your VM console credentials after enabling it:
You can check your dashboard or use the Get VM Console Credentials API call.

Request URL Format:

https://api.ssdnodes.com/servers/{vm_id}/console/{action}

Header Format:

Authorization: Bearer 123456789123456789123456789123456789
Content-Type: application/json

Request Parameters:

Parameter Values Allowed Default Value Description
vm_id* <VM ID>
N/A
 ID of the VM
action* [enable,disable]
N/A
 Specify action to enable or disable console status of a VM

Success Response Format:

[
   {
       "status": "success",
       "msg": "Enable Console task added in queue. Check your dashboard for updates."
   }
]

Error Response Format:

[
   {
       "status": "error",
       "msg": "Action not allowed."
   }
]

CURL Example

                curl -X POST https://api.ssdnodes.com/servers/1234/console/enable -H "Authorization: Bearer 123456789123456789123456789123456789"

Copied!