Resource URL: /platform/<<version=3>>/antivirus/scan

    Overview: This resource allows a client to run an anitvirus scan on a
              single file.

     Methods: POST

********************************************************************************

Method POST: Manually scan a file.

        URL: POST /platform/<<version=3>>/antivirus/scan

There are no query arguments for this method.

Required POST request body fields:
file

POST request body schema:
{
  "additionalProperties": false, 
  "type": "object", 
  "description": "Parameters for a manual antivirus scan.", 
  "properties": {
    "policy": {
      "minLength": 1, 
      "type": "string", 
      "description": "The ID of the policy to use for the scan. By default, the scan will use the MANUAL policy.", 
      "maxLength": 255
    }, 
    "force_run": {
      "type": "boolean", 
      "description": "Forces the scan to run regardless of whether the files were recently scanned. The default value is true."
    }, 
    "file": {
      "minLength": 1, 
      "required": true, 
      "type": "string", 
      "description": "The full path of the file to scan.", 
      "maxLength": 4096
    }, 
    "report_id": {
      "minLength": 1, 
      "type": "string", 
      "description": "The ID for the report for this scan. A report ID will be generated if one is not provided.", 
      "maxLength": 255
    }
  }
}

POST response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "The result of a manual antivirus scan.", 
      "properties": {
        "result": {
          "minLength": 0, 
          "type": "string", 
          "description": "The result of the scan.", 
          "maxLength": 255
        }, 
        "report_id": {
          "minLength": 0, 
          "type": "string", 
          "description": "The ID for the report for this scan. A report ID will be generated if one is not provided. ", 
          "maxLength": 255
        }
      }
    }
  ]
}
