Private Files

Upload a file

post/files

Request

  • Base URL
    https://www.virustotal.com/api/v3/private
  • URL
    https://www.virustotal.com/api/v3/private/files
  • Auth
    none required

Headers

x-apikeystring required

Your API key

Request body multipart/form-data

command_linestring

Command line arguments to use when running the file in sandboxes.

disable_sandboxstring

If true, then the file won't be detonated in sandbox environments. False by default.

enable_internetstring

If the file should have internet access when running in sandboxes. False by default.

filestring binary required
intercept_tlsstring

Intercept HTTPS/TLS/SSL communication. Intercept HTTPS to view encypted URLS, hostnames and HTTP headers. This is detectable by any sample that checks certificates, and makes JA3 hashes unusable.

passwordstring

Optional, password to decompress and scan a file contained in a protected ZIP file.

retention_period_daysinteger

Optional, number of days the report and file are kept in VT (between 1 and 28). If not set it defaults to the group's retention policy preference (1 day by default).

storage_region'US' | 'CA' | 'EU' | 'GB'

Optional, storage region where the file will be stored. By default uses the group's private_scanning.storage_region preference. Allowed values are US, CA, EU, GB

interaction_sandbox'cape_win' | 'cape_linux'

Select the sandbox desired for interactive use.

interaction_timeoutinteger

Interaction timeout in seconds, minimum value: 60. (1 minute.) Max value: 1800: (30 minutes)

locale'EN_US' | 'AR_SA' | 'DE_DE' | 'ES_ES' | 'PT_BR'

Preferred sandbox locale. On windows this selection will change the language and keyboard settings of the analysis machine.

Response

The analysis ID. Use /analyses/<analysis_ID> API call to check the analysis status.

Changes

No recorded changes to this operation across all 1 revision of this API.