SFTP integration

The SFTP integration lets you import CSV files directly from your own SFTP server or export data to your own SFTP server.

How exports work

When you run an export, Bloomreach follows a 2-step process:

Bloomreach exports the data to the SFTP server as a temporary file.
Once the export succeeds, Bloomreach renames the temporary file to the filename set in your export settings.

If step 1 fails, the export retries automatically. Step 2 only runs after a successful export.

Set up the SFTP integration

Go to Data & Assets > Integrations and click + Add new integration.

Add new integration screen in Bloomreach Integrations showing the SFTP option. — Select SFTP from the Add new integration list under **Data & Assets** > **Integrations**.

Select SFTP from the list.
Fill in the following fields:

Field	Required	Description
Host key	Yes	If you don't have a host key, see the guide to SSH keys to learn where to find it. Add the generated public key to your SFTP server.
Hostname	Yes	Plaintext hostname with public DNS records or IP address. Internal IP addresses aren't supported. IPv6 addresses aren't supported. Use an IPv4 address or a hostname that resolves to an IPv4 (A) record.
Password	No	Optional if using public key authentication (recommended).
Port	Yes	Number 0–65535. The port must be open on the firewall for all Bloomreach static IPs listed on the integration screen.
Username	Yes	Name of the SSH user to connect with.

Security recommendations

Use public key authentication instead of password authentication where possible.
Configure your SFTP server firewall to allow only the Bloomreach static IPs listed on the integration screen.

Permissions

The SFTP user must have Read, Write, Execute, and Move/Rename permissions on the target folder of the SFTP server.

Import data from an SFTP server

See the Imports guide to learn how to import your data from an SFTP server.

Limitations

IPv6 not supported: The library Bloomreach uses for SFTP connections doesn't support IPv6. If your SFTP server resolves to an IPv6 address, the connection fails with the following error:

Pysocks doesn't support IPv6: ('2a01:7e01::1', 22, 0, 0)

Workaround: Use an IPv4 address or a hostname that has an IPv4 (A) DNS record. If your server has both IPv4 and IPv6 records, make sure the hostname resolves to the IPv4 address first.