AntivirusReport

The result generated by the Antivirus API.

When using ProcessFile (default), the HTTP response will be a JobSummary with the AntivirusReport as the summary.result field.

When using ProcessFileAndSave, the HTTP response will be a JobSummary, and the saved file will be a JSON file of type AntivirusReport.

Structure

{
  "database": AntivirusDatabase,
  "files": AntivirusReportItem[],
  "scanEndTime": Integer,
  "scanStartTime": Integer
}

Example

{
  "database": {
    "databaseAge": "35 minutes",
    "databaseLastChecked": 1700175432418,
    "databaseLastUpdated": 1700124000000
  },
  "files": [
    {
      "filePath": "/uploads/image.jpg",
      "fileHashSha1": "e25a994746f94939bf27305cab4b9db6c9392e74",
      "viruses": [
        "Win.Ransomware.Example-7013612-0"
      ],
      "status": "Infected"
    }
  ],
  "scanEndTime": 1700173337418,
  "scanStartTime": 1700173332418
}

Properties

database Required

The virus definition database used for this virus scan operation.

Type: AntivirusDatabase

files Required

The file(s) that were scanned for viruses.

Type: AntivirusReportItem[]

scanEndTime Required

The end time of this virus scan operation (in epoch milliseconds).

Example: 1700173337418

Type: Integer

Minimum: 0

scanStartTime Required

The start time of this virus scan operation (in epoch milliseconds).

Example: 1700173332418

Type: Integer

Minimum: 0

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:

UI Widgets

SDKs

Processing APIs

Core APIs

Data Types

More Resources

AntivirusReport

Structure

Example

Properties

database Required

files Required

scanEndTime Required

scanStartTime Required

You are using an outdated browser.