Objects
TCP Proxy
Create Remote Control Session
Changed onCreate 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:
- Call this endpoint with Bearer token authentication
- Server establishes VNC tunnel via agent and returns a session token
- 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
Request
- Base URLhttp://127.0.0.1:8000
- URLhttp://127.0.0.1:8000/v1/objects/{object-id}/remote-control
- AuthHTTP bearer
Path parameters
object-idinteger required
Node object ID
Request body
Response
Remote control session created successfully.
Changes
- info
api operation id
createRemoteControlSessionwas added
- info
- breaking
added required request body
- breaking