# VirusTotal
The VirusTotal actions allow you to interact with VirusTotal API endpoints. These actions work with specified VirusTotal instances which are defined in a given scenario.
This connector uses an API key to authenticate with the API endpoints. The API key can be retrieved while logged into the VirusTotal website. It is found via the VirusTotal user account menu.
# Get a File Report
Action Function: This action gets a VirusTotal report about a file.
Action Properties:
Label
A label for the action
Scenario
The name of the scenario in the connector configuration document.
File ID
The ID of the file in VirusTotal.
Web Timeout
The length of time the request is given before it times out. Leave blank for a default timeout.
Request Status Variable
The HTTP status will be returned in this variable.
Response Variable
The HTTP response will be returned in this variable. The response (if the action is successful) will be VirusTotal information about the file.
Error Message Variable
An error message (if an error occurred) will be returned in this variable.
Action Outputs
Success - The action executed successfully
Failure - An issue was encountered
# Get a URL Report
Action Function: This action gets a VirusTotal report about a given URL.
Action Properties:
Label
A label for the action
Scenario
The name of the scenario in the connector configuration document.
URL ID
The ID of the URL in VirusTotal.
Web Timeout
The length of time the request is given before it times out. Leave blank for a default timeout.
Request Status Variable
The HTTP status will be returned in this variable.
Response Variable
The HTTP response will be returned in this variable. The response (if the action is successful) will be VirusTotal information about the URL.
Error Message Variable
An error message (if an error occurred) will be returned in this variable.
Action Outputs
Success - The action executed successfully
Failure - An issue was encountered
# Get Analysis
Action Function: This action gets a VirusTotal analysis response about a file or URL.
Action Properties:
Label
A label for the action
Scenario
The name of the scenario in the connector configuration document.
Analysis ID
The analysis ID returned by the "Scan URL" action or the "Upload a File" action.
Web Timeout
The length of time the request is given before it times out. Leave blank for a default timeout.
Request Status Variable
The HTTP status will be returned in this variable.
Response Variable
The HTTP response will be returned in this variable.
Error Message Variable
An error message (if an error occurred) will be returned in this variable.
Action Outputs
Success - The action executed successfully
Failure - An issue was encountered
# Scan URL
Action Function: The "Scan URL" action runs a VirusTotal scan on the given URL.
Action Properties:
Label
A label for the action
Scenario
The name of the scenario in the connector configuration document.
URL to Scan
The URL to scan.
Web Timeout
The length of time the request is given before it times out. Leave blank for a default timeout.
Request Status Variable
The HTTP status will be returned in this variable.
Response Variable
The HTTP response will be returned in this variable.
Error Message Variable
An error message (if an error occurred) will be returned in this variable.
Action Outputs
Success - The action executed successfully
Failure - An issue was encountered
# Upload File to VirusTotal
Action Function: The "Upload File to VirusTotal" action uploads the file in the file variable to VirusTotal for scanning. Files must be under 32MB.
Action Properties:
Label
A label for the action
Scenario
The name of the scenario in the connector configuration document.
File Variable to Upload
A file variable containing the file (under 32MB in size) to send to VirusTotal for scanning.
Web Timeout
The length of time the request is given before it times out. Leave blank for a default timeout.
Request Status Variable
The HTTP status will be returned in this variable.
Response Variable
The HTTP response will be returned in this variable.
Error Message Variable
An error message (if an error occurred) will be returned in this variable.
Action Outputs
Success - The action executed successfully
Failure - An issue was encountered