Overview MetaDefender Sandbox API Reference Release Notes
Getting Started
Deployment & Usage
Support
Configuration
2.2.1
Search this version
Configuration
Configuration
Architectural Overview
Features
Title
Message
Create new category
What is the title of your new category?
Edit page index title
What is the title of the page index?
Edit category
What is the new title of your category?
Edit link
What is the new title and URL of your link?
API
Copy Markdown
Open in ChatGPT
Open in Claude
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:
transform.cfg
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' |
Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard
Last updated on
Was this page helpful?
Next to read:
StorageSee the "Technical Datasheet" for a complete list of features: https://docs.opswat.com/filescan/datasheet/technical-datasheet
Discard Changes
Do you want to discard your current changes and overwrite with the template?
Archive Synced Block
Message
Create new Template
What is this template's title?
Delete Template
Message
