Cloudmersive Scan API

openapi: 3.2.0
info:
  version: v1
  title: virusapi Scan API
  description: The Cloudmersive Virus Scan API lets you scan files and content for viruses and identify security issues with content.
servers:
- url: https://localhost
tags:
- name: Scan
paths:
  /virus/scan/file:
    post:
      tags:
      - Scan
      summary: Scan a file for viruses
      description: 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.
      operationId: Scan_File
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VirusScanResult'
            text/json:
              schema:
                $ref: '#/components/schemas/VirusScanResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/VirusScanResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/VirusScanResult'
      security:
      - Apikey: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                inputFile:
                  type: string
                  description: Input file to perform the operation on.
                  format: binary
              required:
              - inputFile
  /virus/scan/file/advanced:
    post:
      tags:
      - Scan
      summary: Advanced Scan a file for viruses
      description: 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.
      operationId: Scan_FileAdvanced
      parameters:
      - name: fileName
        in: header
        description: '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.'
        required: false
        schema:
          type: string
      - name: allowExecutables
        in: header
        description: Set to false to block executable files (program code) from being allowed in the input file.  Default is false (recommended).
        required: false
        schema:
          type: boolean
      - name: allowInvalidFiles
        in: header
        description: 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).
        required: false
        schema:
          type: boolean
      - name: allowScripts
        in: header
        description: 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).
        required: false
        schema:
          type: boolean
      - name: allowPasswordProtectedFiles
        in: header
        description: 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).
        required: false
        schema:
          type: boolean
      - name: allowMacros
        in: header
        description: 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).
        required: false
        schema:
          type: boolean
      - name: allowXmlExternalEntities
        in: header
        description: 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).
        required: false
        schema:
          type: boolean
      - name: allowInsecureDeserialization
        in: header
        description: 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).
        required: false
        schema:
          type: boolean
      - name: allowHtml
        in: header
        description: 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.
        required: false
        schema:
          type: boolean
      - name: allowUnsafeArchives
        in: header
        description: 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.
        required: false
        schema:
          type: boolean
      - name: allowOleEmbeddedObject
        in: header
        description: 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.
        required: false
        schema:
          type: boolean
      - name: allowUnwantedAction
        in: header
        description: 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.
        required: false
        schema:
          type: boolean
      - name: options
        in: header
        description: 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.
        required: false
        schema:
          type: string
      - name: restrictFileTypes
        in: header
        description: 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.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VirusScanAdvancedResult'
            text/json:
              schema:
                $ref: '#/components/schemas/VirusScanAdvancedResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/VirusScanAdvancedResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/VirusScanAdvancedResult'
      security:
      - Apikey: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                inputFile:
                  type: string
                  description: Input file to perform the operation on.
                  format: binary
              required:
              - inputFile
  /virus/scan/website:
    post:
      tags:
      - Scan
      summary: Scan a website for malicious content and threats
      description: Operation includes scanning the content of the URL for various types of malicious content and threats, including viruses and threats (including Phishing).
      operationId: Scan_Website
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebsiteScanResult'
            text/json:
              schema:
                $ref: '#/components/schemas/WebsiteScanResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/WebsiteScanResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/WebsiteScanResult'
      security:
      - Apikey: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebsiteScanRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/WebsiteScanRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/WebsiteScanRequest'
          text/xml:
            schema:
              $ref: '#/components/schemas/WebsiteScanRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/WebsiteScanRequest'
        required: true
components:
  schemas:
    AdditionalAdvancedScanInformation:
      description: Additional non-threat content verification information
      type: object
      properties:
        ContainsJSON:
          description: True if the input file contains JSON data, false otherwise; this is not a threat signal
          type: boolean
        ContainsXML:
          description: True if the input file contains XML data, false otherwise; this is not a threat signal
          type: boolean
        ContainsImage:
          description: True if the input file contains an image
          type: boolean
        Hash_SHA1:
          description: SHA1 hash of input file
          type: string
        RelevantSubfileName:
          description: Relevant subfile name in an archive format for identified threats, if any
          type: string
        RelevantSubfileHash_SHA1:
          description: SHA1 hash of relevant subfile name in an archive format for identified threats, if any
          type: string
        IsAuthenticodeSigned:
          description: True if there is a valid Authenticode signature, False otherwise
          type: boolean
    WebsiteScanResult:
      description: Result of running a website scan
      type: object
      properties:
        CleanResult:
          description: True if the scan contained no threats, false otherwise
          type: boolean
        WebsiteThreatType:
          description: Type of threat returned; can be None, Malware, ForcedDownload or Phishing
          enum:
          - None
          - Malware
          - Phishing
          - ForcedDownload
          - UnableToConnect
          type: string
        FoundViruses:
          description: Array of viruses found, if any
          type: array
          items:
            $ref: '#/components/schemas/VirusFound'
        WebsiteHttpResponseCode:
          format: int32
          description: 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.
          type: integer
    VirusScanResult:
      description: Result of running a virus scan
      type: object
      properties:
        CleanResult:
          description: True if the scan contained no viruses, false otherwise
          type: boolean
        FoundViruses:
          description: Array of viruses found, if any
          type: array
          items:
            $ref: '#/components/schemas/VirusFound'
    VirusFound:
      description: Virus positively identified
      type: object
      properties:
        FileName:
          description: Name of the file containing the virus
          type: string
        VirusName:
          description: Name of the virus that was found
          type: string
    VirusScanAdvancedResult:
      description: Result of running an advanced virus scan
      type: object
      properties:
        CleanResult:
          description: True if the scan contained no viruses, false otherwise
          type: boolean
        ContainsExecutable:
          description: True if the scan contained an executable (application code), which can be a significant risk factor
          type: boolean
        ContainsInvalidFile:
          description: 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
          type: boolean
        ContainsScript:
          description: True if the scan contained a script (such as a PHP script, Python script, etc.) which can be a significant risk factor
          type: boolean
        ContainsPasswordProtectedFile:
          description: True if the scan contained a password protected or encrypted file, which can be a significant risk factor
          type: boolean
        ContainsRestrictedFileFormat:
          description: 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
          type: boolean
        ContainsMacros:
          description: True if the uploaded file contains embedded Macros of other embedded threats within the document, which can be a significant risk factor
          type: boolean
        ContainsXmlExternalEntities:
          description: 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
          type: boolean
        ContainsInsecureDeserialization:
          description: True if the uploaded file contains embedded Insecure Deserialization threats of other embedded threats within the document, which can be a significant risk factor
          type: boolean
        ContainsHtml:
          description: True if the uploaded file contains HTML, which can be a significant risk factor
          type: boolean
        ContainsUnsafeArchive:
          description: 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
          type: boolean
        ContainsOleEmbeddedObject:
          description: True if the uploaded file contains an OLE embedded object, which can be a significant risk factor
          type: boolean
        ContainsUnwantedAction:
          description: True if the uploaded file contains an unwanted automatic action, which can be a significant risk factor
          type: boolean
        VerifiedFileFormat:
          description: 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.
          type: string
        FoundViruses:
          description: Array of viruses found, if any
          type: array
          items:
            $ref: '#/components/schemas/VirusFound'
        ContentInformation:
          $ref: '#/components/schemas/AdditionalAdvancedScanInformation'
          description: Contains additional non-threat content verification information
    WebsiteScanRequest:
      description: Request to scan a website for malicious content
      type: object
      properties:
        Url:
          description: URL of the website to scan; should begin with http:// or https://
          type: string
  securitySchemes:
    Apikey:
      type: apiKey
      description: API Key Authentication
      name: Apikey
      in: header