Data Types

AntivirusReportItem

Element from the files array of the AntivirusReport.

{
"fileHashSha1": String,
"filePath": String,
"skippedReason": String,
"status": String,
"viruses": String[]
}
{
"filePath": "/uploads/image.jpg",
"fileHashSha1": "e25a994746f94939bf27305cab4b9db6c9392e74",
"viruses": [
"Win.Ransomware.Example-7013612-0"
],
"status": "Infected"
}

The scanned file's SHA1 hash.

This field is not present for files that were skipped due to being too large. (These files will have a status of "Skipped".)

Example: "e25a994746f94939bf27305cab4b9db6c9392e74"

Type: String

Min Length: 1

Max Length: 512

The scanned file's path.

Example: "/uploads/image.jpg"

Type: String

Min Length: 1

Max Length: 512

The reason the file was skipped. This field is only present for files with statuses of "Skipped":

"Timeout": file took longer to scan than the Antivirus API's timeout limit (240 seconds).

"FileTooLarge": file is larger than the Antivirus API's file size limit (2GB).

"ContentTooLarge": uncompressed content is larger than the Antivirus API's scan size limit (4GB).

"ArchiveFileCountTooHigh": file is an archive that contains more files than the Antivirus API's limits (10000).

"ArchiveRecursionTooHigh": file is an archive that contains other archives, recursively, deeper than the Antivirus API's limits (10).

"Other": file was skipped due to other internal limits (you may contact support for more information if you receive this error).

Example: "TooLarge"

Type: String

Allowed Values: "ArchiveFileCountTooHigh", "ArchiveRecursionTooHigh", "ContentTooLarge", "FileTooLarge", "Other", "Timeout"

The virus scan summary for this file:

"Healthy": file was successfully scanned and no viruses were detected.

"Infected": file was successfully scanned and at least one virus was detected.

"Skipped": file was skipped; the skippedReason field will contain the reason for the file being skipped.

Example: "Infected"

Type: String

Allowed Values: "Healthy", "Infected", "Skipped"

The viruses that were detected in this file (if any).

Example: ["Win.Ransomware.Example-7013612-0"]

Type: String[]

Was this section helpful? Yes No

You are using an outdated browser.

This website requires a modern web browser -- the latest versions of these browsers are supported: