SFTP Credentials Integration Setup Guide

🕙  2 minute read

SFTP is a secure protocol for file access, file transfer, and file management on a server, using either a Username and Password or SSH key for authentication.

After you set up the integration, the credentials can be used in Workflow SFTP actions. This means you don’t have to reenter the credentials every time you add an SFTP action to a Workflow.

Integrations can only be set up by Admin users and are enabled per team. See our General Integration Information page for an overview of integrations and some recommendations when configuring new integrations.

Required Setup

Configuring SFTP credentials is simple but requires an authentication method. A username and password or SSH key is required to set up the integration.

✅   Heads-up: Your SFTP domain must be available outside of an internal network. You can use a DNS Checker to confirm if your SFTP domain is public. If you get an alert like “Search Error or Records not Exists”, contact your internal IT team to discuss creating an external SFTP domain, or providing a direct IP address for the SFTP server instead.

Create Integration

The following instructions are for creating an integration for the first time. If you already have a connection, select the integration and select Add a Connection, or see How to create a new connection for an existing integration.

  1. Open the overflow menu in the top navigation bar, and select Admin.
  2. Select Integrations at the bottom of the page.
  3. Select the Add an Integration button in the top right corner.
  4. Select the SFTP integration then select Add this Connection.
  5. Fill in the details. Choose the authentication type for your SFTP server.
  6. Based on the authentication type, enter the Username and Password. combination or Username and SSH Key combination specific to the SFTP server.
  7. Enter the SFTP URL for the credentials. This will begin with sftp://
  8. Set the integration permissions if necessary.
  9. Select Connect.
  • Note: We can support SSH-DSS as a host authentication algorithm upon request. You can contact Catalytic Support to discuss enabling this authentication type.

Supported SFTP Encryption Algorithms

In some cases, SFTP triggers and actions will fail depending on the encryption algorithms your SFTP server supports. We support the following encryption algorithms. See exceptions below.

Key exchange algorithms
  • ecdh-sha2-nistp256
  • ecdh-sha2-nistp384
  • ecdh-sha2-nistp521
  • diffie-hellman-group-exchange-sha256
  • diffie-hellman-group14-sha256
  • diffie-hellman-group16-sha512
  • diffie-hellman-group18-sha512
  • diffie-hellman-group14-sha1
  • aes128-ctr
  • aes192-ctr
  • aes256-ctr
  • aes128-gcm
  • aes128-gcm@openssh.com
  • aes256-gcm
  • aes256-gcm@openssh.com
Server host key formats
  • ssh-ed25519
  • ecdsa-sha2-nistp256
  • ecdsa-sha2-nistp384
  • ecdsa-sha2-nistp521
  • ssh-rsa

Catalytic can support the ssh-dss host key format upon request. Please contact Catalytic Support to start this process.

H(MAC) algorithms
  • hmac-sha2-256
  • hmac-sha2-512
  • hmac-sha1
Compression algorithms
  • zlib@openssh.com
  • zlib
  • none

If your encryption method isn’t supported, contact Catalytic Support to work through options.

Sorry about that. What was the most unhelpful part?

Thanks for your feedback

We update the Help Center daily, so expect changes soon.

Link Copied

Paste this URL anywhere to link straight to the section.

Need more help?

If you're signed in to Catalytic Community, you can ask other users a question. You'll be redirected to Community where you can add more info.