API

Configure backend REST API server access.

Proxy usage

See: How to install Sandbox with Proxy support

Step #1 - Open /home/sandbox/sandbox/transform.cfg in a text editor

Step #2 - Modify the server configuration by adding or modifying the following properties:

# Secret apiKey0.secret= apiKey0.authlevel=100 # Server listenServerPort=22001 socketReadTimeout=10000 listenServerEnableHTTPS=true listenServerKeystoreFilename=keystore.bks listenServerKeystorePassword= listenServerKeystoreKeyPassword= # Proxy proxyHost=proxy.example.com proxyPort=3128 proxyUser=optional_user proxyPassword=optional_password nonProxyHosts=localhost proxyType=HTTP

Step #3 - Save the file and restart the sandbox service

Property Details

Property Name	Default value	Description
apiKey0.secret	<generated>	API key, used in HTTP Header: 'secret'. Multiple secrets can be created by following the schema: apiKey<N>.
apiKey0.authlevel	100	Authorization level, for restricted endpoint address. An initial secret is automatically generated during the install process with authlevel 1000 (max), which provides sufficient access for other internal components (broker, webservice).
listenServerPort	22001	HTTP port
socketReadTimeout	10000 ms	HTTP read timeout
listenServerEnableHTTPS	true	Enable HTTPS protocol
proxyHost		Host of proxy server
proxyPort		Port of proxy server
proxyUser		Optional proxy basic auth user
proxyPassword		Optional proxy basic auth password
nonProxyHosts	localhost	A list of hosts which should be reached directly
proxyType	HTTP	Proxy type, can be: 'HTTP', 'DIRECT', 'SOCKS'

Last updated on

Was this page helpful?