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
in
header

Scan

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

OK

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, MSG, and a wide range of image file formats. 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.

fileName: string
in header

Optional: specify the original file name of the file being scanned. By default the file name is taken from inputFile parameter, but if this is not provided, or you wish to override it, you can specify the original file name using this parameter.

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, BAT scripts, JS 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).

allowMacros: boolean
in header

Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros (including support for .DOCX, .XLSX, .PPTX, .DOC and .XLS), and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).

allowXmlExternalEntities: boolean
in header

Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).

allowInsecureDeserialization: boolean
in header

Set to false to block Insecure Deserialization and other threats embedded in JSON and other object serialization files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).

allowHtml: boolean
in header

Set to false to block HTML input in the top level file; HTML can contain XSS, scripts, local file accesses and other threats. Set to true to allow these file types. Default is false (recommended) [for API keys created prior to the release of this feature default is true for backward compatability]. If set to true, HTML files containing script tags will be allowed, but ContainsScript will be set to true if script tags are present.

allowUnsafeArchives: boolean
in header

Set to false to block unsafe archives such as Zip Bombs, and other archives that can cause unsafe extraction outcomes. Default is false (recommended). If set to true, unsafe archives will be allowed.

allowOleEmbeddedObject: boolean
in header

Set to false to block OLE embedded objects, which can contain vulnerabilities and executable code. Default is false (recommended). If set to true, OLE embedded objects will be allowed.

allowUnwantedAction: boolean
in header

Set to false to block unwanted or undesired actions, which can contain execute or open links or content when the file is viewed. Default is false (recommended). If set to true, unwanted actions will be allowed.

options: string
in header

Comma separated set of configuration operations. Include permitJavascriptAndHtmlInPDFs to allow JavaScript and HTML in PDF files. Include permitJavascriptInHtml to allow JavaScript in HTML files. Include blockOfficeXmlOleEmbeddedFile to block embedded OLE files in Office Documents using the modern file format. Include blockInvalidUris to block invalid URIs in Office documents. Include permitAuthenticodeSignedExecutables to allow executables if they have a valid Authenticode signature. Include scanMultipartFile to scan multi-part files such as split zip files. Include ignoreRestrictFileTypesForAttachments to ignore restrictFileTypes setting for file attachments. Default is no options.

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

OK

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",
  "ContainsMacros": "boolean",
  "ContainsXmlExternalEntities": "boolean",
  "ContainsInsecureDeserialization": "boolean",
  "ContainsHtml": "boolean",
  "ContainsUnsafeArchive": "boolean",
  "ContainsOleEmbeddedObject": "boolean",
  "ContainsUnwantedAction": "boolean",
  "VerifiedFileFormat": "string",
  "FoundViruses": [
    {
      "FileName": "string",
      "VirusName": "string"
    }
  ],
  "ContentInformation": {
    "ContainsJSON": "boolean",
    "ContainsXML": "boolean",
    "ContainsImage": "boolean",
    "Hash_SHA1": "string",
    "RelevantSubfileName": "string",
    "RelevantSubfileHash_SHA1": "string",
    "IsAuthenticodeSigned": "boolean"
  }
}
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

OK

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

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'. If the blob path contains Unicode characters, you must base64 encode the blob path and prepend it with 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'.

Code Example:
200 OK
CloudStorageVirusScanResult

OK

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)",
  "ContainsContentModerationRejection": "boolean",
  "ContainsExecutable": "boolean",
  "ContainsInvalidFile": "boolean",
  "ContainsScript": "boolean",
  "ContainsPasswordProtectedFile": "boolean",
  "ContainsRestrictedFileFormat": "boolean",
  "ContainsMacros": "boolean",
  "ContainsXmlExternalEntities": "boolean",
  "ContainsInsecureDeserialization": "boolean",
  "ContainsHtml": "boolean",
  "ContainsUnsafeArchive": "boolean",
  "ContainsOleEmbeddedObject": "boolean",
  "VerifiedFileFormat": "string"
}
Apikey
ScanCloudStorage

Advanced Scan an Azure Blob for viruses

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


Advanced Scan the contents of a single Azure Blob and its content for viruses and threats. 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.



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'. If the blob path contains Unicode characters, you must base64 encode the blob path and prepend it with 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'.

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).

allowMacros: boolean
in header

Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).

allowXmlExternalEntities: boolean
in header

Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).

allowInsecureDeserialization: boolean
in header

Set to false to block Insecure Deserialization and other threats embedded in JSON and other object serialization files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).

allowHtml: boolean
in header

Set to false to block HTML input in the top level file; HTML can contain XSS, scripts, local file accesses and other threats. Set to true to allow these file types. Default is false (recommended) [for API keys created prior to the release of this feature default is true for backward compatability].

allowUnsafeArchives: boolean
in header

Set to false to block unsafe archives such as Zip Bombs, and other archives that can cause unsafe extraction outcomes. Default is false (recommended). If set to true, unsafe archives will be allowed.

allowOleEmbeddedObject: boolean
in header

Set to false to block OLE embedded objects, which can contain vulnerabilities and executable code. Default is false (recommended). If set to true, OLE embedded objects will be allowed.

allowUnwantedAction: boolean
in header

Set to false to block unwanted or undesired actions, which can contain execute or open links or content when the file is viewed. Default is false (recommended). If set to true, unwanted actions will be allowed.

options: string
in header

Comma separated set of configuration operations. Include permitJavascriptAndHtmlInPDFs to allow JavaScript and HTML in PDF files. Include blockOfficeXmlOleEmbeddedFile to block embedded OLE files in Office Documents using the modern file format. Include scanMultipartFile to scan multi-part files such as split zip files. Default is no options.

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
CloudStorageAdvancedVirusScanResult

OK

Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK) 
{
  "Successful": "boolean",
  "CleanResult": "boolean",
  "ContainsExecutable": "boolean",
  "ContainsInvalidFile": "boolean",
  "ContainsScript": "boolean",
  "ContainsPasswordProtectedFile": "boolean",
  "ContainsRestrictedFileFormat": "boolean",
  "ContainsMacros": "boolean",
  "ContainsXmlExternalEntities": "boolean",
  "ContainsInsecureDeserialization": "boolean",
  "ContainsHtml": "boolean",
  "ContainsUnsafeArchive": "boolean",
  "ContainsOleEmbeddedObject": "boolean",
  "VerifiedFileFormat": "string",
  "FoundViruses": [
    {
      "FileName": "string",
      "VirusName": "string"
    }
  ],
  "ErrorDetailedDescription": "string",
  "FileSize": "integer (int64)",
  "ContentInformation": {
    "ContainsJSON": "boolean",
    "ContainsXML": "boolean",
    "ContainsImage": "boolean",
    "Hash_SHA1": "string",
    "RelevantSubfileName": "string",
    "RelevantSubfileHash_SHA1": "string",
    "IsAuthenticodeSigned": "boolean"
  }
}
Apikey
ScanCloudStorage

Advanced Scan an Azure Blob for viruses via a batch job

POST /virus/scan/cloud-storage/azure-blob/single/advanced/batch-job


Via a batch job, advanced Scan the contents of a single Azure Blob and its content for viruses and threats, great for larger/longer processing jobs. Requires Managed Instance or Private Cloud. Returns a job ID which you can then use the Get Job Status API to get the status and output of the job. 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.



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'. If the blob path contains Unicode characters, you must base64 encode the blob path and prepend it with 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'.

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).

allowMacros: boolean
in header

Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).

allowXmlExternalEntities: boolean
in header

Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).

allowInsecureDeserialization: boolean
in header

Set to false to block Insecure Deserialization and other threats embedded in JSON and other object serialization files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).

allowHtml: boolean
in header

Set to false to block HTML input in the top level file; HTML can contain XSS, scripts, local file accesses and other threats. Set to true to allow these file types. Default is false (recommended) [for API keys created prior to the release of this feature default is true for backward compatability].

allowUnsafeArchives: boolean
in header

Set to false to block unsafe archives such as Zip Bombs, and other archives that can cause unsafe extraction outcomes. Default is false (recommended). If set to true, unsafe archives will be allowed.

allowOleEmbeddedObject: boolean
in header

Set to false to block OLE embedded objects, which can contain vulnerabilities and executable code. Default is false (recommended). If set to true, OLE embedded objects will be allowed.

allowUnwantedAction: boolean
in header

Set to false to block unwanted or undesired actions, which can contain execute or open links or content when the file is viewed. Default is false (recommended). If set to true, unwanted actions will be allowed.

options: string
in header

Comma separated set of configuration operations. Include permitJavascriptAndHtmlInPDFs to allow JavaScript and HTML in PDF files. Include blockOfficeXmlOleEmbeddedFile to block embedded OLE files in Office Documents using the modern file format. Include scanMultipartFile to scan multi-part files such as split zip files. Default is no options.

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
ScanCloudStorageBatchJobCreateResult

OK

Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK) 
{
  "Successful": "boolean",
  "AsyncJobID": "string"
}
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. If the key name contains Unicode characters, you must base64 encode the key name and prepend it with 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'.

roleArn: string
in header

Optional: Role ARN for STS Credential-based access. This is for advanced access using the Security Token Service and is not required. If the roleArn contains Unicode characters, you must base64 encode the key name and prepend it with 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'.

Code Example:
200 OK
CloudStorageVirusScanResult

OK

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)",
  "ContainsContentModerationRejection": "boolean",
  "ContainsExecutable": "boolean",
  "ContainsInvalidFile": "boolean",
  "ContainsScript": "boolean",
  "ContainsPasswordProtectedFile": "boolean",
  "ContainsRestrictedFileFormat": "boolean",
  "ContainsMacros": "boolean",
  "ContainsXmlExternalEntities": "boolean",
  "ContainsInsecureDeserialization": "boolean",
  "ContainsHtml": "boolean",
  "ContainsUnsafeArchive": "boolean",
  "ContainsOleEmbeddedObject": "boolean",
  "VerifiedFileFormat": "string"
}
Apikey
ScanCloudStorage

Advanced Scan an AWS S3 file for viruses

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


Advanced Scan the contents of a single AWS S3 file and its content for viruses and threats. 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.



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. If the key name contains Unicode characters, you must base64 encode the key name and prepend it with 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'.

roleArn: string
in header

Optional: Role ARN for STS Credential-based access. This is for advanced access using the Security Token Service and is not required. If the roleArn contains Unicode characters, you must base64 encode the key name and prepend it with 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'.

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).

allowMacros: boolean
in header

Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).

allowXmlExternalEntities: boolean
in header

Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).

allowInsecureDeserialization: boolean
in header

Set to false to block Insecure Deserialization and other threats embedded in JSON and other object serialization files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).

allowHtml: boolean
in header

Set to false to block HTML input in the top level file; HTML can contain XSS, scripts, local file accesses and other threats. Set to true to allow these file types. Default is false (recommended) [for API keys created prior to the release of this feature default is true for backward compatability].

allowUnsafeArchives: boolean
in header

Set to false to block unsafe archives such as Zip Bombs, and other archives that can cause unsafe extraction outcomes. Default is false (recommended). If set to true, unsafe archives will be allowed.

allowOleEmbeddedObject: boolean
in header

Set to false to block OLE embedded objects, which can contain vulnerabilities and executable code. Default is false (recommended). If set to true, OLE embedded objects will be allowed.

allowUnwantedAction: boolean
in header

Set to false to block unwanted or undesired actions, which can contain execute or open links or content when the file is viewed. Default is false (recommended). If set to true, unwanted actions will be allowed.

options: string
in header

Comma separated set of configuration operations. Include permitJavascriptAndHtmlInPDFs to allow JavaScript and HTML in PDF files. Include blockOfficeXmlOleEmbeddedFile to block embedded OLE files in Office Documents using the modern file format. Default is no options.

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
CloudStorageAdvancedVirusScanResult

OK

Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK) 
{
  "Successful": "boolean",
  "CleanResult": "boolean",
  "ContainsExecutable": "boolean",
  "ContainsInvalidFile": "boolean",
  "ContainsScript": "boolean",
  "ContainsPasswordProtectedFile": "boolean",
  "ContainsRestrictedFileFormat": "boolean",
  "ContainsMacros": "boolean",
  "ContainsXmlExternalEntities": "boolean",
  "ContainsInsecureDeserialization": "boolean",
  "ContainsHtml": "boolean",
  "ContainsUnsafeArchive": "boolean",
  "ContainsOleEmbeddedObject": "boolean",
  "VerifiedFileFormat": "string",
  "FoundViruses": [
    {
      "FileName": "string",
      "VirusName": "string"
    }
  ],
  "ErrorDetailedDescription": "string",
  "FileSize": "integer (int64)",
  "ContentInformation": {
    "ContainsJSON": "boolean",
    "ContainsXML": "boolean",
    "ContainsImage": "boolean",
    "Hash_SHA1": "string",
    "RelevantSubfileName": "string",
    "RelevantSubfileHash_SHA1": "string",
    "IsAuthenticodeSigned": "boolean"
  }
}
Apikey
ScanCloudStorage

Virus Scan a file in a SharePoint Online Site Drive

POST /virus/scan/cloud-storage/sharepoint-online/site/single


Virus Scan the contents of a single SharePoint Online Site Drive 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. To get the Client ID and Client Secret, follow these steps: (1) Navigate to the Azure Portal and click on Azure Active Directory, (2) click on App Registrations on the left hand side, (3) click on Register Application, (4) Name the application CloudmersiveAntiVirus and click on Register, (5) Get the client ID by clicking on Overview and copying the value labeled Application (client) ID, (6) click on Certificates and Secrets, (7) click on New client secret, choose a longer expiration and give the secret a name, (8) copy the secret value to the clipboard and save it securely, this is your Client Secret, (9) Now we need to grant permissions to SharePOint; click on API Permissions on the left hand side, (10) click on Add a permission and choose Microsoft Graph, (11) click on Application Permissions, (12) search for Sites.FullControl.All, (13) Click on Add Permissions, (14) now navigate back to Azure Active Directory and click on Enterprise Applications, click on CloudmersiveAntiVirus and click on Permissions, and (15) click on Grant Admin Consent.



clientID: string
in header

Client ID access credentials; see description above for instructions on how to get the Client ID from the Azure Active Directory portal.

clientSecret: string
in header

Client Secret access credentials; see description above for instructions on how to get the Client Secret from the Azure Active Directory portal

sharepointDomainName: string
in header

SharePoint Online domain name, such as mydomain.sharepoint.com

siteID: string
in header

Site ID (GUID) of the SharePoint site you wish to retrieve the file from

tenantID: string
in header

Optional; Tenant ID of your Azure Active Directory

filePath: string
in header

Path to the file within the drive, such as 'hello.pdf' or '/folder/subfolder/world.pdf'. If the file path contains Unicode characters, you must base64 encode the file path and prepend it with 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'.

itemID: string
in header

SharePoint itemID, such as a DriveItem Id

Code Example:
200 OK
CloudStorageVirusScanResult

OK

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)",
  "ContainsContentModerationRejection": "boolean",
  "ContainsExecutable": "boolean",
  "ContainsInvalidFile": "boolean",
  "ContainsScript": "boolean",
  "ContainsPasswordProtectedFile": "boolean",
  "ContainsRestrictedFileFormat": "boolean",
  "ContainsMacros": "boolean",
  "ContainsXmlExternalEntities": "boolean",
  "ContainsInsecureDeserialization": "boolean",
  "ContainsHtml": "boolean",
  "ContainsUnsafeArchive": "boolean",
  "ContainsOleEmbeddedObject": "boolean",
  "VerifiedFileFormat": "string"
}
Apikey
ScanCloudStorage

Advanced Virus Scan a file in a SharePoint Online Site Drive

POST /virus/scan/cloud-storage/sharepoint-online/site/advanced


Advanced Virus Scan the contents of a single SharePoint Online Site Drive file and its content for viruses and threats. 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. To get the Client ID and Client Secret, follow these steps: (1) Navigate to the Azure Portal and click on Azure Active Directory, (2) click on App Registrations on the left hand side, (3) click on Register Application, (4) Name the application CloudmersiveAntiVirus and click on Register, (5) Get the client ID by clicking on Overview and copying the value labeled Application (client) ID, (6) click on Certificates and Secrets, (7) click on New client secret, choose a longer expiration and give the secret a name, (8) copy the secret value to the clipboard and save it securely, this is your Client Secret, (9) Now we need to grant permissions to SharePOint; click on API Permissions on the left hand side, (10) click on Add a permission and choose Microsoft Graph, (11) click on Application Permissions, (12) search for Sites.FullControl.All, (13) Click on Add Permissions, (14) now navigate back to Azure Active Directory and click on Enterprise Applications, click on CloudmersiveAntiVirus and click on Permissions, and (15) click on Grant Admin Consent.



clientID: string
in header

Client ID access credentials; see description above for instructions on how to get the Client ID from the Azure Active Directory portal.

clientSecret: string
in header

Client Secret access credentials; see description above for instructions on how to get the Client Secret from the Azure Active Directory portal

sharepointDomainName: string
in header

SharePoint Online domain name, such as mydomain.sharepoint.com

siteID: string
in header

Site ID (GUID) of the SharePoint site you wish to retrieve the file from

tenantID: string
in header

Optional; Tenant ID of your Azure Active Directory

filePath: string
in header

Path to the file within the drive, such as 'hello.pdf' or '/folder/subfolder/world.pdf'. If the file path contains Unicode characters, you must base64 encode the file path and prepend it with 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'.

itemID: string
in header

SharePoint itemID, such as a DriveItem Id

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).

allowMacros: boolean
in header

Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).

allowXmlExternalEntities: boolean
in header

Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).

allowInsecureDeserialization: boolean
in header

Set to false to block Insecure Deserialization and other threats embedded in JSON and other object serialization files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).

allowHtml: boolean
in header

Set to false to block HTML input in the top level file; HTML can contain XSS, scripts, local file accesses and other threats. Set to true to allow these file types. Default is false (recommended) [for API keys created prior to the release of this feature default is true for backward compatability].

allowUnsafeArchives: boolean
in header

Set to false to block unsafe archives such as Zip Bombs, and other archives that can cause unsafe extraction outcomes. Default is false (recommended). If set to true, unsafe archives will be allowed.

allowOleEmbeddedObject: boolean
in header

Set to false to block OLE embedded objects, which can contain vulnerabilities and executable code. Default is false (recommended). If set to true, OLE embedded objects will be allowed.

allowUnwantedAction: boolean
in header

Set to false to block unwanted or undesired actions, which can contain execute or open links or content when the file is viewed. Default is false (recommended). If set to true, unwanted actions will be allowed.

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
CloudStorageAdvancedVirusScanResult

OK

Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK) 
{
  "Successful": "boolean",
  "CleanResult": "boolean",
  "ContainsExecutable": "boolean",
  "ContainsInvalidFile": "boolean",
  "ContainsScript": "boolean",
  "ContainsPasswordProtectedFile": "boolean",
  "ContainsRestrictedFileFormat": "boolean",
  "ContainsMacros": "boolean",
  "ContainsXmlExternalEntities": "boolean",
  "ContainsInsecureDeserialization": "boolean",
  "ContainsHtml": "boolean",
  "ContainsUnsafeArchive": "boolean",
  "ContainsOleEmbeddedObject": "boolean",
  "VerifiedFileFormat": "string",
  "FoundViruses": [
    {
      "FileName": "string",
      "VirusName": "string"
    }
  ],
  "ErrorDetailedDescription": "string",
  "FileSize": "integer (int64)",
  "ContentInformation": {
    "ContainsJSON": "boolean",
    "ContainsXML": "boolean",
    "ContainsImage": "boolean",
    "Hash_SHA1": "string",
    "RelevantSubfileName": "string",
    "RelevantSubfileHash_SHA1": "string",
    "IsAuthenticodeSigned": "boolean"
  }
}
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. If the object name contains Unicode characters, you must base64 encode the object name and prepend it with 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'.

jsonCredentialFile: file
in formData

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

Code Example:
200 OK
CloudStorageVirusScanResult

OK

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)",
  "ContainsContentModerationRejection": "boolean",
  "ContainsExecutable": "boolean",
  "ContainsInvalidFile": "boolean",
  "ContainsScript": "boolean",
  "ContainsPasswordProtectedFile": "boolean",
  "ContainsRestrictedFileFormat": "boolean",
  "ContainsMacros": "boolean",
  "ContainsXmlExternalEntities": "boolean",
  "ContainsInsecureDeserialization": "boolean",
  "ContainsHtml": "boolean",
  "ContainsUnsafeArchive": "boolean",
  "ContainsOleEmbeddedObject": "boolean",
  "VerifiedFileFormat": "string"
}
Apikey
ScanCloudStorage

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

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


Advanced Scan the contents of a single Google Cloud Platform (GCP) Storage file and its content for viruses and threats. 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.



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. If the object name contains Unicode characters, you must base64 encode the object name and prepend it with 'base64:', such as: 'base64:6ZWV6ZWV6ZWV6ZWV6ZWV6ZWV'.

jsonCredentialFile: file
in formData

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

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).

allowMacros: boolean
in header

Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).

allowXmlExternalEntities: boolean
in header

Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).

allowInsecureDeserialization: boolean
in header

Set to false to block Insecure Deserialization and other threats embedded in JSON and other object serialization files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).

allowHtml: boolean
in header

Set to false to block HTML input in the top level file; HTML can contain XSS, scripts, local file accesses and other threats. Set to true to allow these file types. Default is false (recommended) [for API keys created prior to the release of this feature default is true for backward compatability].

allowUnsafeArchives: boolean
in header

Set to false to block unsafe archives such as Zip Bombs, and other archives that can cause unsafe extraction outcomes. Default is false (recommended). If set to true, unsafe archives will be allowed.

allowOleEmbeddedObject: boolean
in header

Set to false to block OLE embedded objects, which can contain vulnerabilities and executable code. Default is false (recommended). If set to true, OLE embedded objects will be allowed.

allowUnwantedAction: boolean
in header

Set to false to block unwanted or undesired actions, which can contain execute or open links or content when the file is viewed. Default is false (recommended). If set to true, unwanted actions will be allowed.

options: string
in header

Comma separated set of configuration operations. Include permitJavascriptAndHtmlInPDFs to allow JavaScript and HTML in PDF files. Include blockOfficeXmlOleEmbeddedFile to block embedded OLE files in Office Documents using the modern file format. Default is no options.

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
CloudStorageAdvancedVirusScanResult

OK

Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK) 
{
  "Successful": "boolean",
  "CleanResult": "boolean",
  "ContainsExecutable": "boolean",
  "ContainsInvalidFile": "boolean",
  "ContainsScript": "boolean",
  "ContainsPasswordProtectedFile": "boolean",
  "ContainsRestrictedFileFormat": "boolean",
  "ContainsMacros": "boolean",
  "ContainsXmlExternalEntities": "boolean",
  "ContainsInsecureDeserialization": "boolean",
  "ContainsHtml": "boolean",
  "ContainsUnsafeArchive": "boolean",
  "ContainsOleEmbeddedObject": "boolean",
  "VerifiedFileFormat": "string",
  "FoundViruses": [
    {
      "FileName": "string",
      "VirusName": "string"
    }
  ],
  "ErrorDetailedDescription": "string",
  "FileSize": "integer (int64)",
  "ContentInformation": {
    "ContainsJSON": "boolean",
    "ContainsXML": "boolean",
    "ContainsImage": "boolean",
    "Hash_SHA1": "string",
    "RelevantSubfileName": "string",
    "RelevantSubfileHash_SHA1": "string",
    "IsAuthenticodeSigned": "boolean"
  }
}
Apikey
ScanCloudStorage

Get the status and result of a Scan Cloud Storage Batch Job

GET /virus/scan/cloud-storage/batch-job/status


Returns the result of the Async Job - possible states can be STARTED or COMPLETED. This API is only available for Cloudmersive Managed Instance and Private Cloud deployments.



AsyncJobID: string
in query

(no description)

Code Example:
200 OK
ScanCloudStorageJobStatusResult

OK

Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK) 
{
  "Successful": "boolean",
  "AsyncJobStatus": "string",
  "AsyncJobID": "string",
  "Result": {
    "Successful": "boolean",
    "CleanResult": "boolean",
    "ContainsExecutable": "boolean",
    "ContainsInvalidFile": "boolean",
    "ContainsScript": "boolean",
    "ContainsPasswordProtectedFile": "boolean",
    "ContainsRestrictedFileFormat": "boolean",
    "ContainsMacros": "boolean",
    "ContainsXmlExternalEntities": "boolean",
    "ContainsInsecureDeserialization": "boolean",
    "ContainsHtml": "boolean",
    "ContainsUnsafeArchive": "boolean",
    "ContainsOleEmbeddedObject": "boolean",
    "VerifiedFileFormat": "string",
    "FoundViruses": [
      {
        "FileName": "string",
        "VirusName": "string"
      }
    ],
    "ErrorDetailedDescription": "string",
    "FileSize": "integer (int64)",
    "ContentInformation": {
      "ContainsJSON": "boolean",
      "ContainsXML": "boolean",
      "ContainsImage": "boolean",
      "Hash_SHA1": "string",
      "RelevantSubfileName": "string",
      "RelevantSubfileHash_SHA1": "string",
      "IsAuthenticodeSigned": "boolean"
    }
  },
  "JobDuration": "string",
  "ErrorMessage": "string"
}
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

ContainsMacros: boolean

True if the uploaded file contains embedded Macros of other embedded threats within the document, which can be a significant risk factor

ContainsXmlExternalEntities: boolean

True if the uploaded file contains embedded XML External Entity threats of other embedded threats within the document, which can be a significant risk factor

ContainsInsecureDeserialization: boolean

True if the uploaded file contains embedded Insecure Deserialization threats of other embedded threats within the document, which can be a significant risk factor

ContainsHtml: boolean

True if the uploaded file contains HTML, which can be a significant risk factor

ContainsUnsafeArchive: boolean

True if the uploaded file contains unsafe archive (e.g. zip) content, such as a Zip Bomb, or other configurations of a zip file that could lead to an unsafe extraction

ContainsOleEmbeddedObject: boolean

True if the uploaded file contains an OLE embedded object, which can be a significant risk factor

ContainsUnwantedAction: boolean

True if the uploaded file contains an unwanted automatic action, which can be a significant risk factor

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
ContentInformation: AdditionalAdvancedScanInformation

Contains additional non-threat content verification information

Example
{
  "CleanResult": "boolean",
  "ContainsExecutable": "boolean",
  "ContainsInvalidFile": "boolean",
  "ContainsScript": "boolean",
  "ContainsPasswordProtectedFile": "boolean",
  "ContainsRestrictedFileFormat": "boolean",
  "ContainsMacros": "boolean",
  "ContainsXmlExternalEntities": "boolean",
  "ContainsInsecureDeserialization": "boolean",
  "ContainsHtml": "boolean",
  "ContainsUnsafeArchive": "boolean",
  "ContainsOleEmbeddedObject": "boolean",
  "ContainsUnwantedAction": "boolean",
  "VerifiedFileFormat": "string",
  "FoundViruses": [
    {
      "FileName": "string",
      "VirusName": "string"
    }
  ],
  "ContentInformation": {
    "ContainsJSON": "boolean",
    "ContainsXML": "boolean",
    "ContainsImage": "boolean",
    "Hash_SHA1": "string",
    "RelevantSubfileName": "string",
    "RelevantSubfileHash_SHA1": "string",
    "IsAuthenticodeSigned": "boolean"
  }
}

AdditionalAdvancedScanInformation: object

Additional non-threat content verification information

ContainsJSON: boolean

True if the input file contains JSON data, false otherwise; this is not a threat signal

ContainsXML: boolean

True if the input file contains XML data, false otherwise; this is not a threat signal

ContainsImage: boolean

True if the input file contains an image

Hash_SHA1: string

SHA1 hash of input file

RelevantSubfileName: string

Relevant subfile name in an archive format for identified threats, if any

RelevantSubfileHash_SHA1: string

SHA1 hash of relevant subfile name in an archive format for identified threats, if any

IsAuthenticodeSigned: boolean

True if there is a valid Authenticode signature, False otherwise

Example
{
  "ContainsJSON": "boolean",
  "ContainsXML": "boolean",
  "ContainsImage": "boolean",
  "Hash_SHA1": "string",
  "RelevantSubfileName": "string",
  "RelevantSubfileHash_SHA1": "string",
  "IsAuthenticodeSigned": "boolean"
}

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

ContainsContentModerationRejection: boolean

Set to true when using NSFW Content Moderation in the Cloudmersive Storage Protect product (disabled by default)

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

ContainsMacros: boolean

True if the uploaded file contains embedded Macros of other embedded threats within the document, which can be a significant risk factor

ContainsXmlExternalEntities: boolean

True if the uploaded file contains embedded XML External Entity threats of other embedded threats within the document, which can be a significant risk factor

ContainsInsecureDeserialization: boolean

True if the uploaded file contains embedded Insecure Deserialization threats of other embedded threats within the document, which can be a significant risk factor

ContainsHtml: boolean

True if the uploaded file contains HTML, which can be a significant risk factor

ContainsUnsafeArchive: boolean

True if the uploaded file contains unsafe archive (e.g. zip) content, such as a Zip Bomb, or other configurations of a zip file that could lead to an unsafe extraction

ContainsOleEmbeddedObject: boolean

True if the uploaded file contains an OLE embedded object, which can be a significant risk factor

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.

Example
{
  "Successful": "boolean",
  "CleanResult": "boolean",
  "FoundViruses": [
    {
      "FileName": "string",
      "VirusName": "string"
    }
  ],
  "ErrorDetailedDescription": "string",
  "FileSize": "integer (int64)",
  "ContainsContentModerationRejection": "boolean",
  "ContainsExecutable": "boolean",
  "ContainsInvalidFile": "boolean",
  "ContainsScript": "boolean",
  "ContainsPasswordProtectedFile": "boolean",
  "ContainsRestrictedFileFormat": "boolean",
  "ContainsMacros": "boolean",
  "ContainsXmlExternalEntities": "boolean",
  "ContainsInsecureDeserialization": "boolean",
  "ContainsHtml": "boolean",
  "ContainsUnsafeArchive": "boolean",
  "ContainsOleEmbeddedObject": "boolean",
  "VerifiedFileFormat": "string"
}

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

CloudStorageAdvancedVirusScanResult: object

Result of running an advanced 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

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

ContainsMacros: boolean

True if the uploaded file contains embedded Macros of other embedded threats within the document, which can be a significant risk factor

ContainsXmlExternalEntities: boolean

True if the uploaded file contains embedded XML External Entity threats of other embedded threats within the document, which can be a significant risk factor

ContainsInsecureDeserialization: boolean

True if the uploaded file contains embedded Insecure Deserialization threats of other embedded threats within the document, which can be a significant risk factor

ContainsHtml: boolean

True if the uploaded file contains HTML, which can be a significant risk factor

ContainsUnsafeArchive: boolean

True if the uploaded file contains unsafe archive (e.g. zip) content, such as a Zip Bomb, or other configurations of a zip file that could lead to an unsafe extraction

ContainsOleEmbeddedObject: boolean

True if the uploaded file contains an OLE embedded object, which can be a significant risk factor

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: 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

ContentInformation: AdditionalAdvancedScanInformation

Contains additional non-threat content verification information

Example
{
  "Successful": "boolean",
  "CleanResult": "boolean",
  "ContainsExecutable": "boolean",
  "ContainsInvalidFile": "boolean",
  "ContainsScript": "boolean",
  "ContainsPasswordProtectedFile": "boolean",
  "ContainsRestrictedFileFormat": "boolean",
  "ContainsMacros": "boolean",
  "ContainsXmlExternalEntities": "boolean",
  "ContainsInsecureDeserialization": "boolean",
  "ContainsHtml": "boolean",
  "ContainsUnsafeArchive": "boolean",
  "ContainsOleEmbeddedObject": "boolean",
  "VerifiedFileFormat": "string",
  "FoundViruses": [
    {
      "FileName": "string",
      "VirusName": "string"
    }
  ],
  "ErrorDetailedDescription": "string",
  "FileSize": "integer (int64)",
  "ContentInformation": {
    "ContainsJSON": "boolean",
    "ContainsXML": "boolean",
    "ContainsImage": "boolean",
    "Hash_SHA1": "string",
    "RelevantSubfileName": "string",
    "RelevantSubfileHash_SHA1": "string",
    "IsAuthenticodeSigned": "boolean"
  }
}

ScanCloudStorageBatchJobCreateResult: object

Result of performing a convert documentbatch job operation

Successful: boolean

True if successful, false otherwise

AsyncJobID: string

When creating a job, an Async Job ID is returned. Use the GetAsyncJobStatus API to check on the status of this job using the AsyncJobID and get the result when it finishes

Example
{
  "Successful": "boolean",
  "AsyncJobID": "string"
}

ScanCloudStorageJobStatusResult: object

Status of the scan cloud storage job

Successful: boolean

Tru eif the operation to check the status of the job was successful, false otherwise

AsyncJobStatus: string

Returns the job status of the Async Job, if applicable. Possible states are STARTED and COMPLETED

AsyncJobID: string

Job ID of the async batch job

Result: CloudStorageAdvancedVirusScanResult

Output scan result, if applicable

JobDuration: string

Duration of a completed job

ErrorMessage: string

Error message (if any)

Example
{
  "Successful": "boolean",
  "AsyncJobStatus": "string",
  "AsyncJobID": "string",
  "Result": {
    "Successful": "boolean",
    "CleanResult": "boolean",
    "ContainsExecutable": "boolean",
    "ContainsInvalidFile": "boolean",
    "ContainsScript": "boolean",
    "ContainsPasswordProtectedFile": "boolean",
    "ContainsRestrictedFileFormat": "boolean",
    "ContainsMacros": "boolean",
    "ContainsXmlExternalEntities": "boolean",
    "ContainsInsecureDeserialization": "boolean",
    "ContainsHtml": "boolean",
    "ContainsUnsafeArchive": "boolean",
    "ContainsOleEmbeddedObject": "boolean",
    "VerifiedFileFormat": "string",
    "FoundViruses": [
      {
        "FileName": "string",
        "VirusName": "string"
      }
    ],
    "ErrorDetailedDescription": "string",
    "FileSize": "integer (int64)",
    "ContentInformation": {
      "ContainsJSON": "boolean",
      "ContainsXML": "boolean",
      "ContainsImage": "boolean",
      "Hash_SHA1": "string",
      "RelevantSubfileName": "string",
      "RelevantSubfileHash_SHA1": "string",
      "IsAuthenticodeSigned": "boolean"
    }
  },
  "JobDuration": "string",
  "ErrorMessage": "string"
}