Skip to main content

SFTP External Locations

An SFTP external location defines a reusable connection to a remote server, used to securely transfer distribution files over SFTP. Authentication uses a username and password, a private key, or both together. When both are provided, the private key takes priority for authentication.

Create an SFTP external location

  1. In the navigation panel, select the gear icon to open the Administration section.
  2. Select Distribution, then External Locations.
  3. In the Options panel on the right, click Create a new External Location.
  4. Next to Type, select SFTP.
  5. Enter the connection details.
  6. Click Save.

Use for distribution

Once saved, the external location becomes available for use in distribution jobs. Selecting the action Export to External Location from the General tab makes it possible to choose that external location.

SFTP external location properties, including Host, Port, Username, Password, Private Key, and Pass Phrase

SFTP connection details

SFTP PropertyWhat it does
DescriptionEnter a meaningful label to identify the connection.
TypeThe protocol used for the connection.
HostSpecify the server address, IP or domain, of the remote SFTP server.
PortSpecify the communication port. Default: 22.
UsernameEnter the username for authenticating with the server.
PasswordEnter the password associated with the username.
Base DirectoryOptional Define the root directory for file transfers. Leave blank to use the user's root directory.
Private KeyUpload the private key file used for authentication.
Pass PhraseEnter the password for the private key. Required only if the key file is encrypted.
Allow Invalid CertificatesOptional Allow connections to servers with self-signed or expired certificates.
Allow Invalid Certificates

Allowing invalid certificates reduces connection security, and should only be enabled when necessary, such as connecting to a server with a self-signed internal certificate.