Introduction

Secure File Transfer Protocol (SFTP), also known as SSH File Transfer Protocol, is a network protocol that provides file access, file transfer, and file management functionalities over any reliable data stream. SFTP encrypts both commands and data providing effective protection against common network security risks. It ensures that the data is securely transferred using a private and safe data stream.

Setup

Key

For setting up an SFTP file exchange, we require your public key. This key will be associated with your account, reinforcing security for your file transfers.

The key should be in a format compatible with our SFTP server:

File name & format

We need to establish a uniform file name format and content structure to facilitate a seamless and error-free file exchange process.

File name pattern can be customised based on your needs, by default the file names are configured as follow:

File Type Default file name regex
Employees .*employee*.**\\.csv
Calendar .*calendar*.**\\.csv

Usage

The SFTP server's address is sftp.mbrella.io. This is the endpoint you will use to both push data to and pull data from Mbrella. Follow these steps to interact with the server:

  1. Open your SFTP client (FileZilla, Cyberduck, WinSCP, etc.)
  2. Enter sftp.mbrella.io as your host name.
  3. Log in using your SFTP credentials.
  4. Now you are ready to push (upload) or pull (download) data to/from the Mbrella server.

Once a file is added to the SFTP server, it will trigger processing within at most 5 minutes. After the file is processed, it will be moved to an "archive" directory.