> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cloud.cdata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# SFTP

export const title_3 = "SFTP";

export const title_2 = "SFTP";

export const title_1 = "SFTP";

export const title_0 = "SFTP";

## Setup Guide

Follow these steps to connect SFTP to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *SFTP* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Remote Host**, which specifies the host name or IP address of the SFTP server that you want to connect to.
  </Step>

  <Step>
    (Optional) Enter the **Remote Path**, which specifies the working directory on the SFTP server that the provider uses for file operations.
  </Step>

  <Step>
    (Optional) Enter the **Remote Port**, which specifies the port number that the provider uses to connect to the SFTP server. By default, most SFTP servers listen on port 22. Set this property if your server uses a different port.
  </Step>

  <Step>
    Select the **SSH Auth Mode** that the provider uses when connecting to the SFTP server, then proceed to the relevant section below.
  </Step>
</Steps>

## Authentication

<Tabs>
  <Tab title="None">
    <Steps>
      <Step>No additional settings are required for this authentication mode.</Step>

      <Step>
        At the top of the Connect AI **Add {title_0} Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="MultiFactor">
    <Steps>
      <Step>
        Enter the **User**, which specifies the authenticating user's Id.
      </Step>

      <Step>
        Enter the **Password**, which specifies the authenticating user's password.
      </Step>

      <Step>
        (Optional) Enter the **SSH Client Cert**, which is a certificate used for authenticating the SSH user.
      </Step>

      <Step>
        (Optional) Enter the **SSH Client Cert Password**, which is the password of the **SSH Client Cert** key if it has one.
      </Step>

      <Step>
        (Optional) Enter the **SSH Client Cert Subject**, which is the subject of the SSH client certificate. The wildcard value "\*" picks the first certificate in the certificate store.
      </Step>

      <Step>
        (Optional) Select the **SSH Client Cert Type**, which is the type of **SSH Client Cert** private key. Options are **PFXBLOB**, **JKSBLOB**, **PEMKEY\_BLOB**, **PPKBLOB**, and **XMLBLOB**.
      </Step>

      <Step>
        At the top of the Connect AI **Add {title_1} Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Password">
    <Steps>
      <Step>
        Enter the **User**, which specifies the authenticating user's Id.
      </Step>

      <Step>
        Enter the **Password**, which specifies the authenticating user's password.
      </Step>

      <Step>
        At the top of the Connect AI **Add {title_2} Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="PublicKey">
    <Steps>
      <Step>
        Enter the **User**, which specifies the authenticating user's Id.
      </Step>

      <Step>
        (Optional) Enter the **SSH Client Cert**, which is a certificate used for authenticating the SSH user.
      </Step>

      <Step>
        (Optional) Enter the **SSH Client Cert Password**, which is the password of the **SSH Client Cert** key if it has one.
      </Step>

      <Step>
        (Optional) Enter the **SSH Client Cert Subject**, which is the subject of the SSH client certificate. The wildcard value "\*" picks the first certificate in the certificate store.
      </Step>

      <Step>
        (Optional) Select the **SSH Client Cert Type**, which is the type of **SSH Client Cert** private key. Options are **PFXBLOB**, **JKSBLOB**, **PEMKEY\_BLOB**, **PPKBLOB**, and **XMLBLOB**.
      </Step>

      <Step>
        At the top of the Connect AI **Add {title_3} Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and SFTP, see [this information page](https://cdn.cdata.com/help/SFM/cloud/default.htm#default).