Skip to main content
POST
Open a console session

Authorizations

Authorization
string
header
required

Your API key as it is, without Bearer. API access is off for new accounts: until it is turned on under Settings > API, every request answers 403 with API access is turned off for this account. Turn it on under Settings > API. If the account lists allowed IPs, a request from any other address answers 403 with This API key is not allowed from <address>.

Path Parameters

server
string
required

Response

The session is open. Connect to it within ten seconds.

status
boolean
required
Example:

true

url
string
required

The console in the browser, to open in a new window or embed in an iframe. It connects as it loads. The password is in its fragment, which the browser never sends to a server.

Example:

"https://terminal.rdp.sh/novnc/vnc.html?autoconnect=1&resize=scale&encrypt=1&host=terminal.rdp.sh&port=443&path=vnc%3Ftoken%3DeyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI0MjEzIiwic2VydmVyX2lkIjoxOTQwMjksImV4cCI6MTc5MzEwNzAyNywianRpIjoiMWIzOWZjYTQtM2QwNy00NWEwLTk4NmUtN2ExZDc2ZDZjYzY1In0.dWNUOGv-ghEZaq2tVb-7Bw46eZWfynJa9T_iUIAyTUY&quality=4&compression=8#password=x7%26Kq%232m"

websocket_url
string
required

The console's WebSocket, for a page that runs its own noVNC client instead of url. Connect to it and answer the VNC password prompt with password.

Example:

"wss://terminal.rdp.sh/vnc?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI0MjEzIiwic2VydmVyX2lkIjoxOTQwMjksImV4cCI6MTc5MzEwNzAyNywianRpIjoiMWIzOWZjYTQtM2QwNy00NWEwLTk4NmUtN2ExZDc2ZDZjYzY1In0.dWNUOGv-ghEZaq2tVb-7Bw46eZWfynJa9T_iUIAyTUY"

password
string
required

The VNC password of this session. url already carries it.

Example:

"x7&Kq#2m"

expires_at
string<date-time>
required

Connect before this time, ten seconds after the session was opened.

Example:

"2026-10-27T13:17:07+00:00"