• All Files

Upload to SFTP Server

The SFTP external action receives messages and uploads files over a Secure Shell (SSH) connection to specified SSH File Transfer Protocol (SFTP) hosts.

The SFTP external action has two output ports. The success port (✔) can send a message if the upload is successful. The failure port (x) can send a message if the upload fails.

Parameters

Note: See also Working with Parameters in Automations Workflows.

Tip: To test that your parameters work as expected, click Validate.

  • Host: The SFTP host name.
  • Port: The SFTP port number. The default is 22.
  • Username: The SFTP user name for authentication.
  • Password: The SFTP user password for authentication.
  • Verify Host Keys: Whether or not to verify the host key for the server connection.
  • Path to Known Hosts File: If Verify Host Keys is Yes, the path to the known_hosts file that contains the public keys for any servers you wish to connect to. If the known_hosts file is saved to a Resources directory, click the ellipsis (...) and select the file. Otherwise, enter the file path directly. File paths must use forward slashes (/) or escaped backslashes (\\).

    • Note: A known_hosts file contains public keys for computers you connect to via SSH. To obtain a public key and insert it into the known_hosts file, run the following command in OpenSSH: ssh-keyscan -t rsa <hostname> > <path_to_known_hosts_file>. Alternatively, contact your system administrator.

    For more information about OpenSSH, and to install, see http://www.openssh.com/.

  • Destination Path: The destination path to upload the file.
  • Source Path: The source file to upload. If the source file is saved to a Resources directory, click the ellipsis (...) and select the file. Otherwise, enter the file path directly. File paths must use forward slashes (/) or escaped backslashes (\\).

Example

Mouse-over to view:

Output Keys

See Also

Key Description
time Event time
source Event type
file.path (Success port only) File path
error.type (Failure port only) Error type
error.message (Failure port only) Error message