Initiating a VNC Session

A VNC client can be used to remotely control a server. To initiate a VNC session, you need a VNC client installed on your computer. To connect to a server, you need to obtain the server's IP address, port number, and a password using the following syntax:

POST baseURL/ve/{ve-name}/console

The call will return a password to be used to establish a VNC connection in the following format:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<pwd-response>
    <id>2</id>
    <message>Console configuration initiated</message>
    <password>4cnk2J0L</password>
</pwd-response>

The VNC initiation procedure will take some time. Once it is completed on the server side, the ve/console structure will be populated with the server connection information. You can use a callback to be notified when the initiation procedure is completed. To obtain the server connection information, use the GET baseURL/ve/{ve-name} call. The IP address and port number will be included in the <console> element:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ve>
  ...
  <console>
    <address>192.168.1.5</address>
    <port>4468</port>
  </console>
  ...
</ve>