Export files to FTP servers

Usage example

{
  "steps": {
    "exported": {
      "robot": "/ftp/store",
      "use": ":original",
      "credentials": "YOUR_FTP_CREDENTIALS",
      "path": "my_target_folder/${unique_prefix}/${file.url_name}"
    }
  }
}

Parameters

• output_meta

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

  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 videos, you can add the "colorspace: true" parameter to extract the colorspace of the output video.

  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.

• result

  boolean (default: false)

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

• queue

  batch

  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_accept

  boolean (default: false)

  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.

• use

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

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

  Tip

  That's likely all you need to know about use, but you can view Advanced use cases.

• credentials

  string

  Please create your associated Template Credentials in your Transloadit account and use the name of your Template Credentials as this parameter's value. They will contain the values for your FTP host, user and password.

  While we recommend to use Template Credentials at all times, some use cases demand dynamic credentials for which using Template Credentials with their static nature is too unwieldy. If you have this requirement, feel free to use the following parameters instead: "host", "user", "password".

• port

  string | number (default: 21)

  The port to use for the FTP connection.

• path

  string (default: "${unique_prefix}/${file.url_name}")

  The path at which the file is to be stored. This can contain any available Assembly variables.

  Please note that you might need to include your homedir at the beginning of the path.

• url_template

  string (default: "https://{HOST}/{PATH}")

  The URL of the file in the result JSON. The following Assembly variables are supported.

• ssl_url_template

  string (default: "https://{HOST}/{PATH}")

  The SSL URL of the file in the result JSON. The following Assembly variables are supported.

• secure

  boolean (default: false)

  Determines whether to establish a secure connection to the FTP server using SSL.

Demos

Related blog posts