/api/start/:token

Start a new Xrdp session

Method

POST

Parameters

  • command — command to execute
  • geometry — [optional] size of the desktop ( widthxheight ). Set to “rootless” for multiple window mode
  • name — [optional] initial display name when listing sessions

Result

JSON object with the following members

  • id — Xrdp session id
  • password — password used to launch the Xrdp connection
  • geometry — width and height of the Xrdp session ( widthxheight )
  • windowMode — window mode of the Xrdp session ( rootless or desktop )
  • RdpPort — RDP port the Xrdp session is listening on
  • SshPort — The SSH port the SSH daemon is listening on
  • Hostname — the hostname of the Xrdp session