Package index • virustotal

Authentication

set_key(): Set VirusTotal API Key
is_api_key_configured(): Check if API key is properly configured

Reports

Look up what VirusTotal already knows about a file, URL, domain or IP.

file_report(): Get File Scan Report
url_report(): Get URL Report
domain_report(): Get Domain Report
ip_report(): Get IP Address Report
get_analysis(): Get Analysis Results

Scanning and rescanning

scan_file(): Submit a file for scanning
scan_url(): Submit URL for scanning
rescan_domain(): Request rescan of a domain
rescan_file(): Request rescan of a file
rescan_ip(): Request rescan of an IP address
rescan_url(): Request rescan of a URL
get_file_upload_url(): Get file upload URL for large files

Comments and votes

get_domain_comments(): Retrieve comments for an Internet domain
get_file_comments(): Retrieve comments for a file
get_ip_comments(): Retrieve comments for an IP address
get_url_comments(): Retrieve comments for a URL
post_domain_comments(): Add a comment to an Internet domain
post_file_comments(): Add a comment to a file
post_ip_comments(): Add a comment to an IP address
post_url_comments(): Add a comment to a URL
get_domain_votes(): Retrieve votes for an Internet domain
get_file_votes(): Retrieve votes for a file
get_ip_votes(): Retrieve votes for an IP address
get_url_votes(): Retrieve votes for a URL
post_domain_votes(): Add a vote for a hostname or domain
post_file_votes(): Add a vote to a file
post_ip_votes(): Add a vote for an IP address
post_url_votes(): Add a vote to a URL

Relationships and object info

get_domain_info(): Retrieve information about an Internet domain
get_ip_info(): Retrieve information about an IP address
get_domain_relationship(): Retrieve related objects to an Internet domain
get_file_relationships(): Retrieve relationships for a file
get_url_relationships(): Retrieve relationships for a URL

File downloads

download_file(): Download a file from VirusTotal
get_file_download_url(): Get download URL for a file

Sandbox behaviour

get_file_behaviour_summary(): Get File Behaviour Summary
get_file_behaviour_mitre_trees(): Get File Behaviour MITRE ATT&CK Trees
get_file_behaviours(): Get File Behaviours
get_behaviour_report(): Get Behaviour Report
get_behaviour_html(): Get Behaviour HTML Report
get_behaviour_evtx(): Get Behaviour EVTX File
get_behaviour_pcap(): Get Behaviour PCAP File
get_behaviour_memdump(): Get Behaviour Memory Dump

Response classes

virustotal_file_report(): Create a VirusTotal file report
virustotal_domain_report(): Create a VirusTotal domain report
virustotal_ip_report(): Create a VirusTotal IP report
virustotal_file_scan(): Create a VirusTotal file scan result
virustotal_url_scan(): Create a VirusTotal URL scan result
print(<virustotal_response>): Print method for VirusTotal responses
print(<virustotal_file_report>): Print method for file reports
print(<virustotal_domain_report>): Print method for domain reports
summary(<virustotal_response>): Summary method for VirusTotal responses

Errors

virustotal_error(): Create a VirusTotal API error
virustotal_auth_error(): Create an authentication error
virustotal_rate_limit_error(): Create a rate limit error
virustotal_validation_error(): Create a validation error
print(<virustotal_error>): Print method for VirusTotal errors

Package utilities

virustotal_info(): Print package information and configuration status
virustotal_version(): Get package version information