SFTP Quick Start

What is SFTP?

SFTP (Secure File Transfer Protocol) is a transport layer protocol used to securely transfer files over SSH (Secure Shell). Secure shell encryption ensures high levels of security when exchanging files or content via SFTP. The SFTP protocol is a client-server model file exchange mechanism: one side hosts an SFTP server, and the other side connects to it as an SFTP client.

How does MFT Gateway SFTP work?

MFT Gateway can take either side of the client-server model on your behalf, depending on how your trading partner works:

  • In server mode, MFT Gateway acts as an SFTP server, allowing your trading partners to connect to you as SFTP clients and exchange messages.
  • In client mode, MFT Gateway acts as an SFTP client and connects to your trading partner’s own SFTP server to upload the files you send and to retrieve the files they make available for you.

In both modes, you would be able to send messages to your trading partners over SFTP from the web console, integrations (S3, SFTP), and the REST API, and view the messages exchanged under SFTP Message view.

To represent your business partner, you can create an SFTP partner as needed under your MFT Gateway account. The SFTP service is enabled by default. You can set which message exchanging protocols are enabled or disabled for your account by clicking on the ‘Organization profile’ in the top right corner and selecting the ‘Message services’ option.

SFTP Message Services

SFTP Partner in the MFT Gateway

The MFT Gateway’s SFTP protocol is simpler and easier to configure. In SFTP, you do not need to configure any identities for yourself. All you have to do is set up an SFTP partner inside your MFT Gateway account to represent your business partner, and choose the mode for that partner. You can have both server mode and client mode partners in the same account.

 Server ModeClient Mode
SFTP server hosted byMFT GatewayYour trading partner
Who connectsYour partner connects to the MFT Gateway SFTP server with any SFTP clientMFT Gateway connects to your partner’s SFTP server
AuthenticationSSH key pairPassword, SSH private key, or both
Receiving files from your partnerYour partner uploads files to the MFT Gateway SFTP serverMFT Gateway retrieves files from your partner’s SFTP server, on a schedule or on demand
Choose whenYour partner doesn’t have an SFTP serverYour partner has an SFTP server and expects you to connect to it

To create an SFTP partner, select the ‘Partners’ option from the left navigation menu, select ‘SFTP’ from the service drop-down at the top of the page, then click the New SFTP Partner button and choose Server Mode or Client Mode. The mode can’t be changed after the partner is created.

New SFTP Partner drop-down

  • Server Mode – MFT Gateway creates an SFTP user with the appropriate credentials to connect to the MFT Gateway SFTP server. Refer to Adding a Server Mode Partner.
  • Client Mode – MFT Gateway stores the connection details and credentials of your partner’s SFTP server. Refer to Adding a Client Mode Partner.

In the partner list and in the message lists, each partner and message is marked with its mode.