Private URLs

Private Scan URL

post/urls

Request

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

Headers

x-apikeystring required

Your API key

Request body application/x-www-form-urlencoded

urlstring required

URL to scan.

user_agentstring

User agent string.

sandboxesstring

Comma separated eg: chrome_headless_linux,cape_win,zenbox_windows possible values chrome_headless_linux, cape_win and zenbox_windows.

retention_period_daysinteger

Optional, number of days the report and URL 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 URL will be stored. By default uses the group's private_scanning.storage_region preference. Allowed values are US, CA, EU, GB

interaction_sandboxstring

Select the sandbox desired for interactive use, possible values cape_win.

interaction_timeoutinteger

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

Response

200

object required

Changes

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