4.7.1 Create an SFTP Profile

Create an SFTP profile to define connection parameters, such as user credentials and SFTP server details.

Prerequisites

Before you begin, complete the following tasks:

  • Generate an API signing key and copy the private key value.
  • Note down the username, host name, and port number to access the SFTP server.

You'll need to provide this information while creating an SFTP profile.

To create an SFTP Profile:
  1. Open the navigation menu and click Connectors.
  2. Click SFTP.

    The SFTP profile list page opens. All the SFTP profiles that you have defined are displayed in a table.

  3. Click add a new building block.
    The New SFTP Profile dialog box appears.
  4. Enter the following information.
    • Name: Enter a unique and descriptive name to identify this SFTP profile in workflows. The name can be up to 128-characters long. Use only letters, numbers, underscores (_), and hyphens (-). Spaces and other special characters are not supported.
    • Username: Specify the username used to authenticate and connect to the SFTP server.
    • Host: Enter the hostname or IP address of the SFTP server to which you want to connect.
    • Port: Enter the network port for the SFTP connection (default is usually 22).
    • Private Key: Paste the private SSH key required for key-based authentication with the SFTP server.
    • Pass Phrase: Pass phrase for the private key, if any. Click the eye icon to show/hide the value if needed.
  5. Click Test to ensure that you can establish a connection with the provided details.
    If there are any issues, an error message is displayed. Note down the error message so that you can troubleshoot the issue, and then click Close.
  6. Click Submit to create the SFTP profile.
The new profile appears in the list of available SFTP profiles. Reference this name in your SFTP tasks to connect to the specified SFTP server.