The following definitions explain each of the malware file scanner API's data points:
|
Field |
Description | Possible Values |
|
success |
Indicates if the API request was successful. | boolean |
| message | The response message string for this request. This usually returns "Success" but can include information on why a request failed. | string |
| file_hash | A sha256 hash of the provided file. | string |
| type | The type of scan. | string |
| status | Dependent on the type of scan, possible values include: "completed", "cached", or "pending" | string |
| result | The result of the scan, which lists if any threat engines detected a virus, rootkit, ransomware, keylogger, or similar type of malicious file | json |
| update_url | if the status is pending, request this URL to fetch the result | string |
| request_id | A unique identifier for this request that you can use to look up the request details or send a postback conversion notice. | string |
| errors | An array of errors that occurred while attempting to process this request. | array of strings |