Page tree

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.


  • Linux- and Windows-based SFTP servers are supported. 


  • Ingest of over 500 files through SFTP at one time is not supported.
  • You cannot run jobs using Avro or Parquet sources uploaded via SFTP.
  • When you specify a parameterized output as part of your job execution, the specified output location may include additional unnecessary information about the SFTP connection identifier. None of this information is sensitive. This is a known issue.
  • Jobs can be executed from SFTP sources on the following running environments:
    • D s photon
    • HDFS-based Spark, which includes Cloudera and Hortonworks

  • You cannot publish TDE format to SFTP destinations.
  • You cannot publish compressed Snappy files to SFTP destinations.


  • Acquire user credentials to access the SFTP server. You can use username/password credentials or SSH keys. See below.

  • Verify that the credentials can access the proper locations on the server where your data is stored. Initial directory of the user account must be accessible.


By default, this connection type is automatically enabled. If it is not enabled in your environment, please complete the following: 


  1. D s config
  2. Locate the following parameter and set it to true:

    Code Block
    "feature.sftp.enabled": true,
  3. Save your changes and restart the platform.


NOTE: You must provide the protocol identifier and storage locations for the SMTP server. See below.

Configure file storage protocols and locations


  1. Login to the application.
  2. In the menu, select Settings menu > Settings > Connections. See Connections Page.
  3. In the Connections page, click Create Connection. See Create Connection Window.
  4. In the Create Connection window, click the SFTP connection card.
  5. Specify the properties for your SFTP server.


    The hostname of the FTP server to which you are connecting. Do not include any protocol identifier (sftp://).

    PortThe port number to use to connect to the server. Default port number is 22.
    Credential Type

    Select one of the following:

    basic - authenticate via username and password

    SSH Key - authenticate via username and SSH key

    User NameThe username to use to connect.
    Password(Basic credential type) The password associated with the username.
    SSH Key(SSH Key credential type) The SSH key that applies to the username.
    Test ConnectionClick this button to test the connection that you have specified.
    Default DirectoryAbsolute path on the SFTP server where users of the connection can begin browsing.
    Block Size (Bytes)

    Fetch size in bytes for each read from the SFTP server.


    NOTE: Raising this value may increase speed of read operations. However, if it is raised too high, resources can become overwhelmed, and the read can fail.

    Connection NameThe name of the connection as you want it to appear in the application.
    DescriptionThis description is displayed in the application.

    For more information, see Create Connection Window.

  6. Click Save