Skip to content

UserSettings

Model of User Settings

Field Type Description Required Default
classification Classification Default submission classification
Yes
TLP:C
deep_scan Boolean Should a deep scan be performed?
Yes
False
description Keyword Default description
Yes
``
download_encoding Enum Default download encoding when downloading files
Values:
"cart", "raw", "zip"
Yes
cart
default_external_sources List [Keyword] List of sha256 sources to check by default
Yes
[]
default_zip_password Text Default user-defined password for creating password protected ZIPs when downloading files
Yes
zippy
executive_summary Boolean Should executive summary sections be shown?
Yes
True
expand_min_score Integer Auto-expand section when score bigger then this
Yes
500
generate_alert Boolean Generate an alert?
Yes
False
ignore_cache Boolean Ignore service caching?
Yes
False
ignore_dynamic_recursion_prevention Boolean Ignore dynamic recursion prevention?
Yes
False
ignore_filtering Boolean Ignore filtering services?
Yes
False
malicious Boolean Is the file submitted already known to be malicious?
Yes
False
priority Integer Default priority for the submissions
Yes
1000
profile Boolean Should the submission do extra profiling?
Yes
False
service_spec Mapping [String, Mapping [String, Any]] Default service specific settings
Yes
{}
services ServiceSelection Default service selection
Yes
See ServiceSelection for more details.
submission_view Enum Default view for completed submissions
Values:
"details", "report"
Yes
report
ttl Integer Default submission TTL, in days
Yes
30