Virus Scan API API Reference

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

API Endpoint

https://api.cloudmersive.com

Schemes: https

Version: v1

Authentication

Apikey

API Key Authentication

type

apiKey

name

Apikey

header

Scan

Scan a file for viruses

POST /virus/scan/file

Scan files and content for viruses. Leverage continuously updated signatures for millions of threats, and advanced high-performance scanning capabilities. Over 17 million virus and malware signatures. Continuous cloud-based updates. Wide file format support including Office, PDF, HTML, Flash. Zip support including .Zip, .Rar, .DMG, .Tar, and other archive formats. Multi-threat scanning across viruses, malware, trojans, ransomware, and spyware. High-speed in-memory scanning delivers subsecond typical response time.

inputFile: file

in formData

Input file to perform the operation on.

Code Example:

200 OK

VirusScanResult

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

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


Apikey

Scan

Advanced Scan a file for viruses

POST /virus/scan/file/advanced

Advanced Scan files with 360-degree Content Protection across Viruses and Malware, executables, invalid files, scripts, and even restrictions on accepted file types with complete content verification. Customize threat rules to your needs. Leverage continuously updated signatures for millions of threats, and advanced high-performance scanning capabilities. Over 17 million virus and malware signatures. Continuous cloud-based updates. Block threats beyond viruses including executables, scripts, invalid files, and more. Optionally limit input files to a specific set of file types (e.g. PDF and Word Documents only). Wide file format support including Office, PDF, HTML, Flash. Zip support including .Zip, .Rar, .DMG, .Tar, and other archive formats. Multi-threat scanning across viruses, malware, trojans, ransomware, and spyware. High-speed in-memory scanning delivers subsecond typical response time.

inputFile: file

in formData

Input file to perform the operation on.

allowExecutables: boolean

in header

Set to false to block executable files (program code) from being allowed in the input file. Default is false (recommended).

allowInvalidFiles: boolean

in header

Set to false to block invalid files, such as a PDF file that is not really a valid PDF file, or a Word Document that is not a valid Word Document. Default is false (recommended).

allowScripts: boolean

in header

Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file. Set to true to allow these file types. Default is false (recommended).

allowPasswordProtectedFiles: boolean

in header

Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended).

restrictFileTypes: string

in header

Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files. All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult=false. Set restrictFileTypes parameter to null or empty string to disable; default is disabled.

Code Example:

200 OK

VirusScanAdvancedResult

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "CleanResult": "boolean",
  "ContainsExecutable": "boolean",
  "ContainsInvalidFile": "boolean",
  "ContainsScript": "boolean",
  "ContainsPasswordProtectedFile": "boolean",
  "ContainsRestrictedFileFormat": "boolean",
  "VerifiedFileFormat": "string",
  "FoundViruses": [
    {
      "FileName": "string",
      "VirusName": "string"
    }
  ]
}


Apikey

Scan

Scan a website for malicious content and threats

POST /virus/scan/website

Operation includes scanning the content of the URL for various types of malicious content and threats, including viruses and threats (including Phishing).

WebsiteScanRequest

undefined

Code Example:

Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded

Request Example

{
  "Url": "string"
}

200 OK

WebsiteScanResult

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "CleanResult": "boolean",
  "WebsiteThreatType": "string",
  "FoundViruses": [
    {
      "FileName": "string",
      "VirusName": "string"
    }
  ],
  "WebsiteHttpResponseCode": "integer (int32)"
}


Apikey

ScanCloudStorage

Scan an Azure Blob for viruses

POST /virus/scan/cloud-storage/azure-blob/single

Scan the contents of a single Azure Blob and its content for viruses. Leverage continuously updated signatures for millions of threats, and advanced high-performance scanning capabilities. Over 17 million virus and malware signatures. Continuous cloud-based updates. Wide file format support including Office, PDF, HTML, Flash. Zip support including .Zip, .Rar, .DMG, .Tar, and other archive formats. Multi-threat scanning across viruses, malware, trojans, ransomware, and spyware. High-speed in-memory scanning delivers subsecond typical response time.

connectionString: string

in header

Connection string for the Azure Blob Storage Account; you can get this connection string from the Access Keys tab of the Storage Account blade in the Azure Portal.

containerName: string

in header

Name of the Blob container within the Azure Blob Storage account

blobPath: string

in header

Path to the blob within the container, such as 'hello.pdf' or '/folder/subfolder/world.pdf'

Code Example:

200 OK

CloudStorageVirusScanResult

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "Successful": "boolean",
  "CleanResult": "boolean",
  "FoundViruses": [
    {
      "FileName": "string",
      "VirusName": "string"
    }
  ],
  "ErrorDetailedDescription": "string",
  "FileSize": "integer (int64)"
}


Apikey

ScanCloudStorage

Scan an AWS S3 file for viruses

POST /virus/scan/cloud-storage/aws-s3/single

Scan the contents of a single AWS S3 file and its content for viruses. Leverage continuously updated signatures for millions of threats, and advanced high-performance scanning capabilities. Over 17 million virus and malware signatures. Continuous cloud-based updates. Wide file format support including Office, PDF, HTML, Flash. Zip support including .Zip, .Rar, .DMG, .Tar, and other archive formats. Multi-threat scanning across viruses, malware, trojans, ransomware, and spyware. High-speed in-memory scanning delivers subsecond typical response time.

accessKey: string

in header

AWS S3 access key for the S3 bucket; you can get this from My Security Credentials in the AWS console

secretKey: string

in header

AWS S3 secret key for the S3 bucket; you can get this from My Security Credentials in the AWS console

bucketRegion: string

in header

Name of the region of the S3 bucket, such as 'US-East-1'

bucketName: string

in header

Name of the S3 bucket

keyName: string

in header

Key name (also called file name) of the file in S3 that you wish to scan for viruses

Code Example:

200 OK

CloudStorageVirusScanResult

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "Successful": "boolean",
  "CleanResult": "boolean",
  "FoundViruses": [
    {
      "FileName": "string",
      "VirusName": "string"
    }
  ],
  "ErrorDetailedDescription": "string",
  "FileSize": "integer (int64)"
}


Apikey

ScanCloudStorage

Scan an Google Cloud Platform (GCP) Storage file for viruses

POST /virus/scan/cloud-storage/gcp-storage/single

Scan the contents of a single Google Cloud Platform (GCP) Storage file and its content for viruses. Leverage continuously updated signatures for millions of threats, and advanced high-performance scanning capabilities. Over 17 million virus and malware signatures. Continuous cloud-based updates. Wide file format support including Office, PDF, HTML, Flash. Zip support including .Zip, .Rar, .DMG, .Tar, and other archive formats. Multi-threat scanning across viruses, malware, trojans, ransomware, and spyware. High-speed in-memory scanning delivers subsecond typical response time.

bucketName: string

in header

Name of the bucket in Google Cloud Storage

objectName: string

in header

Name of the object or file in Google Cloud Storage

jsonCredentialFile: file

in formData

Service Account credential for Google Cloud stored in a JSON file.

Code Example:

200 OK

CloudStorageVirusScanResult

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "Successful": "boolean",
  "CleanResult": "boolean",
  "FoundViruses": [
    {
      "FileName": "string",
      "VirusName": "string"
    }
  ],
  "ErrorDetailedDescription": "string",
  "FileSize": "integer (int64)"
}


Apikey

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"
}

VirusScanAdvancedResult: object

Result of running an advanced virus scan

CleanResult: boolean: True if the scan contained no viruses, false otherwise
ContainsExecutable: boolean: True if the scan contained an executable (application code), which can be a significant risk factor
ContainsInvalidFile: boolean: True if the scan contained an invalid file (such as a PDF that is not a valid PDF, Word Document that is not a valid Word Document, etc.), which can be a significant risk factor
ContainsScript: boolean: True if the scan contained a script (such as a PHP script, Python script, etc.) which can be a significant risk factor
ContainsPasswordProtectedFile: boolean: True if the scan contained a password protected or encrypted file, which can be a significant risk factor
ContainsRestrictedFileFormat: boolean: True if the uploaded file is of a type that is not allowed based on the optional restrictFileTypes parameter, false otherwise; if restrictFileTypes is not set, this will always be false
VerifiedFileFormat: string: For file format verification-supported file formats, the contents-verified file format of the file. Null indicates that the file format is not supported for contents verification. If a Virus or Malware is found, this field will always be set to Null.
FoundViruses: VirusFound: Array of viruses found, if any
VirusFound

Example

{
  "CleanResult": "boolean",
  "ContainsExecutable": "boolean",
  "ContainsInvalidFile": "boolean",
  "ContainsScript": "boolean",
  "ContainsPasswordProtectedFile": "boolean",
  "ContainsRestrictedFileFormat": "boolean",
  "VerifiedFileFormat": "string",
  "FoundViruses": [
    {
      "FileName": "string",
      "VirusName": "string"
    }
  ]
}

WebsiteScanRequest: object

Request to scan a website for malicious content

Url: string: URL of the website to scan; should begin with http:// or https://

Example

{
  "Url": "string"
}

WebsiteScanResult: object

Result of running a website scan

CleanResult: boolean: True if the scan contained no threats, false otherwise
WebsiteThreatType: string None, Malware, Phishing, ForcedDownload, UnableToConnect: Type of threat returned; can be None, Malware, ForcedDownload or Phishing
FoundViruses: VirusFound: Array of viruses found, if any
VirusFound
WebsiteHttpResponseCode: integer (int32): The remote server URL HTTP reasponse code; useful for debugging issues with scanning; typically if the remote server returns a 200 or 300-series code this means a successful response, while a 400 or 500 series code would represent an error returned from the remote server for the provided URL.

Example

{
  "CleanResult": "boolean",
  "WebsiteThreatType": "string",
  "FoundViruses": [
    {
      "FileName": "string",
      "VirusName": "string"
    }
  ],
  "WebsiteHttpResponseCode": "integer (int32)"
}

CloudStorageVirusScanResult: object

Result of running a virus scan on cloud storage

Successful: boolean: True if the operation of retrieving the file, and scanning it were successfully completed, false if the file could not be downloaded from cloud storage, or if the file could not be scanned. Note that successful completion does not mean the file is clean; for the output of the virus scanning operation itself, use the CleanResult and FoundViruses parameters.
CleanResult: boolean: True if the scan contained no viruses, false otherwise
FoundViruses: CloudStorageVirusFound: Array of viruses found, if any
CloudStorageVirusFound
ErrorDetailedDescription: string: Detailed error message if the operation was not successful
FileSize: integer (int64): Size in bytes of the file that was retrieved and scanned

Example

{
  "Successful": "boolean",
  "CleanResult": "boolean",
  "FoundViruses": [
    {
      "FileName": "string",
      "VirusName": "string"
    }
  ],
  "ErrorDetailedDescription": "string",
  "FileSize": "integer (int64)"
}

CloudStorageVirusFound: 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"
}