Scan files for viruses

Usage example

{
  "steps": {
    "scanned": {
      "robot": "/file/virusscan",
      "use": ":original",
      "error_on_decline": true,
      "error_msg": "At least one of the uploaded files is malicious and was declined"
    }
  }
}

Parameters

• interpolate

  boolean | Record<string, boolean>

• output_meta

  Record<string, boolean> | boolean | Array<string>

• result

  boolean (default: false)

• queue

  batch

• force_accept

  boolean (default: false)

• ignore_errors

  boolean | Array<meta | execute> (default: [])

• use

  string | Array<string> | Array<object> | object

• error_on_decline

  boolean (default: false)

• error_msg

  string (default: "One of your files was declined")

Demos

Related blog posts

  This <dfn>Robot</dfn> is built on top of [ClamAV](https://www.clamav.net/), the best open source antivirus engine available. We update its signatures on a daily basis.

By default, this Robot excludes all malicious files from further processing without any additional notification. This behavior can be changed by setting error_on_decline to true, which will stop Assemblies as soon as malicious files are found. Such Assemblies will then be marked with an error.

We allow the use of industry standard EICAR files for integration testing without needing to use potentially dangerous live virus samples.

Scan uploaded files and throw an error if a malicious file is detected:

Controls whether Assembly Variables are interpolated for individual instruction fields.

By default, most Robot instruction fields interpolate Assembly Variables. Set this to false to treat every instruction field as literal text, or set an individual field path to false to treat only that field as literal text. For Robot-specific fields that are literal by default, set this to true or set that field path to true to opt back into interpolation.

Use field names such as path, or dotted paths such as ffmpeg.vf for nested objects.

Whether the results of this Step should be present in the Assembly Status JSON

Setting the queue to 'batch', manually downgrades the priority of jobs for this step to avoid consuming Priority job slots for jobs that don't need zero queue waiting times

Force a Robot to accept a file type it would have ignored.

By default, Robots ignore files they are not familiar with. 🤖/video/encode, for example, will happily ignore input images.

With the force_accept parameter set to true, you can force Robots to accept all files thrown at them. This will typically lead to errors and should only be used for debugging or combatting edge cases.

Ignore errors during specific phases of processing.

Setting this to ["meta"] will cause the Robot to ignore errors during metadata extraction.

Setting this to ["execute"] will cause the Robot to ignore errors during the main execution phase.

Setting this to true is equivalent to ["meta", "execute"] and will ignore errors in both phases.

Specifies which Step(s) to use as input.

• You can pick any names for Steps except ":original" (reserved for user uploads handled by Transloadit)
• You can provide several Steps as input with arrays:
  

  {
    "use": [
      ":original",
      "encoded",
      "resized"
    ]
  }
  

• You can also tag input Steps with as to pass semantic intent to robots:
  

  {
    "use": [
      {
        "name": ":original",
        "as": "image"
      },
      {
        "name": ":original",
        "as": "mask"
      }
    ]
  }
  

If this is set to true and one or more files are declined, the Assembly will be stopped and marked with an error.

The error message shown to your users (such as by Uppy) when a file is declined and error_on_decline is set to true.

Allows you to specify a set of metadata that is more expensive on CPU power to calculate, and thus is disabled by default to keep your Assemblies processing fast.

For images, you can add "has_transparency": true in this object to extract if the image contains transparent parts and "dominant_colors": true to extract an array of hexadecimal color codes from the image.

For images, you can also add "blurhash": true to extract a BlurHash string — a compact representation of a placeholder for the image, useful for showing a blurred preview while the full image loads.

For videos, you can add the "colorspace: true" parameter to extract the colorspace of the output video.

For videos, you can also add "interlaced": true to detect whether the video is interlaced. This combines the cheap ffprobe field_order flag with a bounded idet sampling pass over the first frames of the source, exposing interlaced, field_order, and a diagnostic interlace_detection object under file.meta. This is computationally expensive and billed accordingly.

For audio, you can add "mean_volume": true to get a single value representing the mean average volume of the audio file.

You can also set this to false to skip metadata extraction and speed up transcoding.