All chapters
On this page

Transfer actions / Action reference

SCP transfer

Manual / Actions / Transfer

Transfer a file over SSH.

Read Shared action rules for disabling this action, outputs, error routing, and recovery. Also read File sources and destinations.

Configuration and behavior

Parameter Default Notes
SSH credential * - A stored credential of type SSH (username plus password or private key).
Direction Upload Download fetches a remote file and the job continues on it.
Source file ${item.path} Upload.
Host * - Hostname or IPv4 address, no port. IPv6 literals unsupported. The editor warns when the host contains :.
Port 22
Remote path * - Upload: a path ending in /, such as /ingest/, or an existing folder keeps the file's name in that folder; any other path is the new file name, e.g. /ingest/${item.basename}_v2${item.ext}. Download: the remote file. A path without a leading / starts in the login's home folder.
Local directory - Download only. Must already exist.
Overwrite off

Outputs: remote_path, path, host_key_accepted. Transfers use SFTP with stage-and-rename. The remote folder must already exist. Host keys are trusted on first use and recorded in the node's known_hosts; a later key change fails the step with does not match the recorded host key - remove the stale entry if the host legitimately changed.

Both directions show file transfer progress and recent speed in job detail. Finishing covers remote close and rename on upload, or the final disk save and publication on download. See File transfer progress.