virusapi API Reference

Virus API lets you scan files and content for viruses and identify security issues with content.

Swagger OpenAPI Specification | .NET Framework Client | .NET Core Client | Java Client | Node.JS Client | Python Client | Drupal Client

API Endpoint
https://api.cloudmersive.com
Schemes: https
Version: v1

Authentication

Apikey

API Key Authentication

type
apiKey
name
Apikey
in
header

Paths

Scan a file for viruses

POST /virus/scan/file


inputFile: file
in formData

Input file to perform the operation on.

Code Example:

OK

Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
  "CleanResult": "boolean",
  "FoundViruses": [
    {
      "FileName": "string",
      "VirusName": "string"
    }
  ]
}

Schema Definitions

VirusScanResult: object

Result of running a virus scan

CleanResult: boolean

True if the scan contained no viruses, false otherwise

FoundViruses: VirusFound

Array of viruses found, if any

VirusFound
Example
{
  "CleanResult": "boolean",
  "FoundViruses": [
    {
      "FileName": "string",
      "VirusName": "string"
    }
  ]
}

VirusFound: object

Virus positively identified

FileName: string

Name of the file containing the virus

VirusName: string

Name of the virus that was found

Example
{
  "FileName": "string",
  "VirusName": "string"
}