Skip to content
Docs

SFTP

Connect SSH file-transfer endpoints with a password or a private key. SFTP is the most common partner-exchange protocol. Available on Pro plans and above.

Last updated July 17, 2026

#What you need

SFTP connects SSH file-transfer servers and is available on Pro plans and above. Create an SFTP credential with:

  • Host and port (default 22).
  • Username.
  • Either a password, or a private key file (.pem) with an optional passphrase.

#Password or private key

FileAgent supports both password and private-key authentication for SFTP. To use a key, choose Use private key file instead of password, upload the private key, and provide its passphrase if it has one. Key-based authentication is preferred by many partners and avoids storing a reusable password.

#Permissions and allowlists

  • Use a service account scoped to the exchange directory, with read/list on sources and write (and delete for Move/Sync-Mirror/Purge) on destinations.
  • Many partners allowlist by IP — ask whether your host's public IP needs to be registered.

#Set up and test

  1. Create the credential under Credentials → New credential → SFTP.
  2. Enter host, port, and username, then choose password or upload a private key.
  3. Choose Test connection before saving.

For timeouts or key errors, see SFTP troubleshooting.