NEnetxms
TCP Proxy

Create TCP Proxy Session

Changed on

Create a TCP proxy session and return a short-lived token for WebSocket connection. This is the first step in establishing a TCP proxy connection. 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 to create a TCP tunnel
  2. Server establishes connection to target via agent and returns a session token
  3. Connect to /v1/tcp-proxy/{token} WebSocket endpoint (no auth header needed)

This flow is designed to work with browser WebSocket API which cannot send custom Authorization headers.

Required Permissions:

  • System access right: SYSTEM_ACCESS_SETUP_TCP_PROXY
  • Object access right: OBJECT_ACCESS_CONTROL on the target or proxy object
post/v1/tcp-proxy

Request

  • Base URL
    http://127.0.0.1:8000
  • URL
    http://127.0.0.1:8000/v1/tcp-proxy
  • Auth
    HTTP bearer

Request body

allowControlMessagesboolean

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

proxyIdinteger

Proxy node ID or zone object ID. If specified, the connection will be established through this proxy node. Either proxyId or nodeId must be specified.

nodeIdinteger

Target node ID. If proxyId is not specified, the server will automatically select the appropriate proxy for this node. Either proxyId or nodeId must be specified.

addressstring ip-address

Target IP address. Required when proxyId is specified. When using nodeId, the node's primary IP address is used automatically.

portinteger required

Target TCP port number (required).

Response

TCP proxy session created successfully.

tokenstring uuid

Session token for WebSocket connection

expiresIninteger

Token validity period in seconds

wsUrlstring

WebSocket URL path to connect to

Changes