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

    Overview: This resource represents global configuration for Antivirus.

     Methods: GET, PUT

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

Method GET: Retrieve the Antivirus settings.

       URL: GET /platform/<<version=3>>/antivirus/settings

There are no query arguments for this method.

GET 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"
        }
      }
    }, 
    {
      "type": "object", 
      "properties": {
        "settings": {
          "additionalProperties": false, 
          "type": "object", 
          "description": "Antivirus settings.", 
          "properties": {
            "repair": {
              "type": "boolean", 
              "description": "Try to repair files when threats are found."
            }, 
            "scan_on_close": {
              "type": "boolean", 
              "description": "Scan files when apps close them."
            }, 
            "service": {
              "type": "boolean", 
              "description": "Whether the antivirus service is enabled."
            }, 
            "fail_open": {
              "type": "boolean", 
              "description": "Allow access when scanning fails."
            }, 
            "scan_on_open": {
              "type": "boolean", 
              "description": "Scan files on access."
            }, 
            "report_expiry": {
              "minimum": 0, 
              "type": "integer", 
              "description": "Amount of time in seconds until old reporting data is purged.", 
              "maximum": 4294967295
            }, 
            "quarantine": {
              "type": "boolean", 
              "description": "Try to quarantine files when threats are found."
            }, 
            "path_prefixes": {
              "minItems": 0, 
              "items": {
                "minLength": 0, 
                "type": "string", 
                "pattern": "^/ifs.*", 
                "maxLength": 4096
              }, 
              "type": "array", 
              "description": "Paths to include in realtime scans.", 
              "maxItems": 4294967295
            }, 
            "glob_filters_include": {
              "type": "boolean", 
              "description": "If true, only scan files matching a glob filter. If false, only scan files that don't match a glob filter."
            }, 
            "glob_filters": {
              "minItems": 0, 
              "items": {
                "minLength": 0, 
                "type": "string", 
                "maxLength": 255
              }, 
              "type": "array", 
              "description": "Glob patterns for leaf filenames.", 
              "maxItems": 4294967295
            }, 
            "scan_size_maximum": {
              "minimum": 0, 
              "type": "integer", 
              "description": "Skip scanning files larger than this.", 
              "maximum": 4294967295
            }, 
            "truncate": {
              "type": "boolean", 
              "description": "Try to truncate files when threats are found."
            }, 
            "glob_filters_enabled": {
              "type": "boolean", 
              "description": "Enable glob filters."
            }
          }
        }
      }
    }
  ]
}

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

Method PUT: Modify the Antivirus settings. All input fields are optional, but
            one or more must be supplied.

       URL: PUT /platform/<<version=3>>/antivirus/settings

There are no query arguments for this method.

PUT request body schema:
{
  "additionalProperties": false, 
  "type": "object", 
  "description": "Antivirus settings.", 
  "properties": {
    "repair": {
      "type": "boolean", 
      "description": "Try to repair files when threats are found."
    }, 
    "scan_on_close": {
      "type": "boolean", 
      "description": "Scan files when apps close them."
    }, 
    "service": {
      "type": "boolean", 
      "description": "Whether the antivirus service is enabled."
    }, 
    "fail_open": {
      "type": "boolean", 
      "description": "Allow access when scanning fails."
    }, 
    "scan_on_open": {
      "type": "boolean", 
      "description": "Scan files on access."
    }, 
    "report_expiry": {
      "minimum": 0, 
      "type": "integer", 
      "description": "Amount of time in seconds until old reporting data is purged.", 
      "maximum": 4294967295
    }, 
    "quarantine": {
      "type": "boolean", 
      "description": "Try to quarantine files when threats are found."
    }, 
    "path_prefixes": {
      "minItems": 0, 
      "items": {
        "minLength": 0, 
        "type": "string", 
        "pattern": "^/ifs.*", 
        "maxLength": 4096
      }, 
      "type": "array", 
      "description": "Paths to include in realtime scans.", 
      "maxItems": 4294967295
    }, 
    "glob_filters_include": {
      "type": "boolean", 
      "description": "If true, only scan files matching a glob filter. If false, only scan files that don't match a glob filter."
    }, 
    "glob_filters": {
      "minItems": 0, 
      "items": {
        "minLength": 0, 
        "type": "string", 
        "maxLength": 255
      }, 
      "type": "array", 
      "description": "Glob patterns for leaf filenames.", 
      "maxItems": 4294967295
    }, 
    "scan_size_maximum": {
      "minimum": 0, 
      "type": "integer", 
      "description": "Skip scanning files larger than this.", 
      "maximum": 4294967295
    }, 
    "truncate": {
      "type": "boolean", 
      "description": "Try to truncate files when threats are found."
    }, 
    "glob_filters_enabled": {
      "type": "boolean", 
      "description": "Enable glob filters."
    }
  }
}

There is no JSON response body for this method.
