Retention Policy Configuration
Configuration on the Admin panel
You can configure the retention under the Webservice Admin (UX) panel as well.
For that click on the user icon on the top right corner and select "Admin" panel:
Then select "Settings" in the middle:
Select "Configuration":
Under the "Retention" tab you can set retention policy:
By default, retention is enabled and set to 365 days.
Configuration options
| Field | Description |
|---|---|
RETENTION_ENABLED | Enable or disable data retention |
RETENTION_DELETE_REPORT | Enable or disable deleting retention report |
RETENTION_PERIOD_MALICIOUS | Set retention period for malicious files (the value is in days, set to 0 for indefinite storage) |
RETENTION_PERIOD_SUSPICIOUS | Set retention period for suspicious files (the value is in days, set to 0 for indefinite storage) |
RETENTION_PERIOD_INFORMATIONAL | Set retention period for informational files (the value is in days, set to 0 for indefinite storage) |
RETENTION_PERIOD_UNKNOWN | Set retention period for unknown files (the value is in days, set to 0 for indefinite storage) |
RETENTION_PERIOD_BENIGN | Set retention period for benign files (the value is in days, set to 0 for indefinite storage) |
Backend configuration
By default, the system is designed to clean up locally stored results/received samples and other temporary files. These cleanup operations are performed either upon starting up the service (single-pass) or on continuous short-cycle intervals in a background process. To enable regular cleanup during the server mode, make sure the following options are enabled:
| File | Option Name |
|---|---|
| broker.properties | runFileSystemCleanup |
| transform.properties | runFileSystemCleanup |
By default, the following retention period is applied (see “Retention Policy” sections in both the broker and transform server properties files):
| File | Option Name | Retention Period in minutes (days) |
|---|---|---|
| Analysis Results | deleteResultsPathArtifactsOlderThanXMinutes | 1440 (1 day) |
| Sample Files | deleteResultsPathArtifactsOlderThanXMinutes | 10080 (7 days) |
| Temp Files | deleteResultsPathArtifactsOlderThanXMinutes | 2880 (2 days) |
| Queued Files | deleteResultsPathArtifactsOlderThanXMinutes | 1440 (1 day) |
Note: the queued files are only cleaned up if automatic re-queue is disabled (not by default). The automatic re-queue feature is designed to allow a downtime of the broker without losing previously submitted files from being processed. To change this behavior, configure the requeuePendingTasksFromPreviousTermination option.