v51

latestOpenAPI 3.0.2raw.githubusercontent.com2026-08-01245104440.0 KB
Objects
TCP Proxy

Create Remote Control Session

Create a remote control (VNC) session for a node and return a short-lived token for WebSocket connection. This is a convenience endpoint that automatically determines VNC connection parameters based on the node's configuration.

The endpoint uses the node's configured VNC port and proxy settings to establish a TCP tunnel. The returned token should be used to connect to the WebSocket endpoint /v1/tcp-proxy/{token}.

Two-Phase Authorization Flow:

  1. Call this endpoint with Bearer token authentication
  2. Server establishes VNC tunnel via agent and returns a session token
  3. Connect to /v1/tcp-proxy/{token} WebSocket endpoint (no auth header needed)

Required Permissions:

  • System access right: SYSTEM_ACCESS_SETUP_TCP_PROXY
  • Object access rights: OBJECT_ACCESS_READ and OBJECT_ACCESS_CONTROL on the node
post/v1/objects/{object-id}/remote-control

Path parameters

object-idinteger required

Node object ID

Request body

allowControlMessagesboolean

If true, server will send JSON control messages in text frames (default is false)

Response

Remote control session created successfully.

tokenstring uuid

Session token for WebSocket connection

expiresIninteger

Token validity period in seconds

wsUrlstring

WebSocket URL path to connect to