11.2. Proxy (Connector) API Specifics

The Proxy API is enabled by default, but only listens to localhost connections on port 8096.

The proxy REST API can be disabled with the tpm flag:

connector-rest-api=false

If required, the listen port can be changed using the tpm option:

connector-rest-api-port=8096

Exposing the API to a different network address for remote access, like an internal network, consists in changing the listen address of the API server.

For example, granting access to local 192.168.1.* network would translate to the tpm option:

connector-rest-api-address=192.168.1.0

Warning

Note that exposing the API to a public network can introduce a security breach like brute-force or DDoS attack exposure

The Proxy specific Developer Docs can be viewed here