API
Configure backend REST API server access.
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:
x
# SecretapiKey0.secret=apiKey0.authlevel=100# ServerlistenServerPort=22001socketReadTimeout=10000listenServerEnableHTTPS=truelistenServerKeystoreFilename=keystore.bkslistenServerKeystorePassword=listenServerKeystoreKeyPassword=# ProxyproxyHost=proxy.example.comproxyPort=3128proxyUser=optional_userproxyPassword=optional_passwordnonProxyHosts=localhostproxyType=HTTPStep #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' |
Was this page helpful?
