Configuring SFTP Destinations

Secure FTP (SFTP) is a secure way to transfer exports and scheduled reports to remote servers.

SSH Options For SFTP

Secure File Transfer Protocol (SFTP) is based on the Secure Shell technology (SSH); the following SSH options are supported for SFTP delivery.

SSH Option	Supported Values
ECDSA	ecdsa-sha2-nistp256 ecdsa-sha2-nistp384 ecdsa-sha2-nistp521
Public Key Algorithm	ssh-dss ssh-rsa

Watch Video

Adding SFTP Configuration

In multi-property operations, SFTP configuration can be global (all properties) or property-specific.

Note:

The SFTP Hostname must be added to the Outbound Domain Allowlist prior to being configured. The default port for Secure FTP (SFTP) is 22. For more information, see Configuring Outbound Domain Allow Listings.

Tip:

The Hostname Key can be obtained by executing the following bash/shell command: {{ssh-keyscan <hostname>. When using a non-standard port (other than 22) ssh-keyscan -p <port> <hostname>}}

From the Toolbox menu, select System Setup , and then select SFTP Configuration.
Click New and complete the following:
1. Context: Select a value from the list.
  1. Global: Select to define a chain-level SFTP configuration available to all properties.
  2. Property: Select to define a property-specific SFTP configuration.
2. SFTP Code: Enter Unique SFTP Code you want to create, preferably with the following recommended format:
  1. When creating at Chain Level use CHAIN CODE+SFTP CODE.
  2. When creating at Property Level use PROP CODE+SFTP CODE.
3. Description: Enter a description.
4. Host Name: Enter the SFTP Server Hostname.
5. Port Number: Enter the Port Number.
6. Auth Type: Select an authentication type:
  1. Password: Use to authenticate using basic authentication method such as user account and password details.
    1. Username: Enter the username.
    2. Password: Enter the password
    3. Host Key: Enter the public key of the server specified in Host Name (the server's public key).
  2. Key: To authenticate using open authorization method such as OAuth Token URL and credential details.
    1. Username: Enter the username.
    2. Private Key: Enter the private key.
    3. Host Key: Enter the public key of the server specified in Host Name (the server's public key).
  3. Key with Passphrase: To authenticate using open authorization details like, OAuth Token URL and credential details.
    1. Username: Enter the username.
    2. Private Key: Enter the private key.
    3. Passphrase: Enter the passphrase.
    4. Host Key: Enter the public key of the server specified in Hostname (the server's public key).
  4. Folders: Click Add Rows to add the number of specified rows.
    1. Folder Name: Enter the logical name for the specified folder path.
    2. Folder Path: Enter the folder path.
Click Save.

Editing SFTP Configuration

From the Toolbox menu, select System Setup , and then SFTP Configuration.
Enter search criteria and click Search.
Select the SFTP in search result, click the vertical ellipsis Actions menu and select Edit.
1. Update configuration.
2. Inactive: Select the checkbox to set the SFTP connection inactive. Deselect the checkbox to activate.
Click Save.

Validating SFTP Connectivity

Validate folders individually, then refresh page to view validation status. If configuration has been edited, each folder location will require re-validation.

From the Toolbox menu, select System Setup , and then SFTP Configuration.
Enter search criteria and click Search.
Select the SFTP Code in search results, click the vertical ellipsis Actions menu and select Edit.
Click Add Rows to add folder and folder path.
1. Folder Name: Enter the logical name for the specified folder path.
2. Folder Path: Enter the folder path.
  
  Note:
  Each folder must be validated prior to saving the SFTP configuration. Refresh the page to view validation status.
  1. Click the vertical ellipsis Actions menu and select Validate.
  2. Select Refresh to view the validation status of each folder.
  3. Click Save.

Deleting SFTP Configuration

Note:

Ensure the SFTP Hostname is also removed from the Outbound Domain Allowlist. For more information, see Configuring Outbound Domain Allow Listings.

From the Toolbox menu, select System Setup , and then SFTP Configuration.
Enter search criteria and click Search.
Select the SFTP in search result, click vertical ellipsis Actions menu and select Delete.
Click Delete to confirm.