Sign in
Guacamole

Generate Guacamole connection token from host configuration

Fetches host configuration from database and generates a connection token for RDP/VNC/Telnet

post/guacamole/connect-host/{hostId}

Path parameters

hostIdinteger required

Host ID to connect to

Request body

protocol'rdp' | 'vnc' | 'telnet'

Override the host's default connection type

promptedUsernamestring

Username for this connection only, used when the host's RDP auth type is "none". Not persisted.

promptedPasswordstring

Password for this connection only, used when the host's RDP auth type is "none". Not persisted.

Response

Connection token generated successfully

tokenstring

Encrypted connection token

guacamoleConnectionIdstring nullable

guacd's own connection id for this session, once the handshake completes. Used to mint session-share join tokens.

Changes

No recorded changes to this endpoint across all 1 revision of this API.