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 90 days for malicious samples and 14 days for non-malicious samples.

Note that scan reports are not deleted by default.

Configuration options

FieldDescription
RETENTION_ENABLEDEnable or disable data retention
RETENTION_DELETE_REPORTEnable or disable deleting retention report
RETENTION_PERIOD_MALICIOUSSet retention period for malicious files (the value is in days, set to 0 for indefinite storage)
RETENTION_PERIOD_SUSPICIOUSSet retention period for suspicious files (the value is in days, set to 0 for indefinite storage)
RETENTION_PERIOD_INFORMATIONALSet retention period for informational files (the value is in days, set to 0 for indefinite storage)
RETENTION_PERIOD_UNKNOWNSet retention period for unknown files (the value is in days, set to 0 for indefinite storage)
RETENTION_PERIOD_BENIGNSet 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:

FileOption Name
broker.cfgrunFileSystemCleanup
transform.cfgrunFileSystemCleanup

By default, the following retention period is applied (see “Retention Policy” sections in both broker.cfg and transform.cfg files):

FileOption NameRetention Period in minutes
Analysis ResultsdeleteResultsPathArtifactsOlderThanXMinutes120 (2 hours)
Sample FilesdeleteStoredSamplesOlderThanXMinutes120 (2 hours)
Temp FilesdeleteTempFilesOlderThanXMinutes120 (2 hours)
Queued FilesdeleteQueueFilesIfOlderThanXMinutes120 (2 hours)

Note: the queued files are only cleaned up if automatic re-queue is disabled (by default). To change this behavior, configure the requeuePendingTasksFromPreviousTermination option.

Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard