API v1 is deprecated and will be turned off on January 1, 2022. Check out the API v2 documentation.

You can use any FTP server as storage both for input and output of conversions. Therefore we recommend for security reasons to create a seperate user / password login to your FTP server with limited rights.

The following example shows how to start such a conversion. Please read the documentation about the other necassary parameters for starting conversions.

Parameter Description
input/output.ftp.host * The FTP server host. (Required)
input/output.ftp.port The port the FTP server is bind to. (Optional, Default: 21)
input/output.ftp.user * FTP username. (Required)
input/output.ftp.password * FTP password. (Required)
file * Filename, including path, of the input file. (Required)
output.ftp.path Filename, including path, for the output file. If not set the key will be choosen automatically (filename.outformat). If this value ends with "/" the output file is stored in the corresponding directory. (Optional)

SFTP

Similarly, you can use any SFTP server. Therefore we recommend for security reasons to create a seperate user / password / private key login to your SFTP server with limited rights.

The following example shows how to start such a conversion. Please read the documentation about the other necassary parameters for starting conversions.

Parameter Description
input/output.sftp.host * The SFTP server host. (Required)
input/output.sftp.port The port the SSH server is bind to. (Optional, Default: 22)
input/output.sftp.user * SFTP username. (Required)
input/output.sftp.password * SFTP password. (Optional)
input/output.sftp.privatekey * SFTP private key, alternatively to providing a password. (Optional)
file * Filename, including path, of the input file. (Required)
output.ftp.path Filename, including path, for the output file. If not set the key will be choosen automatically (filename.outformat). If this value ends with "/" the output file is stored in the corresponding directory. (Optional)