# FTP Helper

## Overview

The FTP Helper is an FTP client that allows you to list, read (download), upload, move and delete files on an FTP server.

<figure><img src="https://291121471-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-McrRFZHYH27bqKzOVDd%2Fuploads%2FgbHtT8Me3aKyv0F7mbVX%2Fimage.png?alt=media&#x26;token=e097fdec-5c19-43f2-ba26-59606a024ccc" alt="" width="205"><figcaption></figcaption></figure>

## Authentication

Go to the [**Connector Auth**](https://app.locoia.com/connector-auth?page=1\&perPage=10\&includeEmbedded=false\&sortProp=updated_date\&sortOrder=descending) screen in order to setup your FTP credentials.

There, fill in all the required fields, click **Confirm**, and the credentials will then be automatically validated.

### Username and Password (standard)

This is the standard FTP authentication type, which supports all FTP protocols (FTP, FTPS, SFTP) and requires a username and password:

<figure><img src="https://291121471-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-McrRFZHYH27bqKzOVDd%2Fuploads%2FHZvPuI8p5ulJlDtG15r0%2Fimage.png?alt=media&#x26;token=87be67ff-74a2-47b4-a06c-39557c4c37bc" alt="" width="563"><figcaption></figcaption></figure>

#### Non-Standard Encoding

By default, UTF-8 is used for all FTP connections and actions. In case a FTP server uses an outdated configuration that does not support UTF-8, a supported encoding can be selected.

Please reach out to us if you require an encoding which is not shown as an option yet.

### Private SSH Key

This auth type supports (by definition) only the SFTP protocol and instead of a password, a private key needs to be uploaded:

<figure><img src="https://291121471-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-McrRFZHYH27bqKzOVDd%2Fuploads%2FNkOGVqS6mpojmXZoLaPW%2Fimage.png?alt=media&#x26;token=74f974f3-6ceb-4181-9ee1-6e4b5e8c6312" alt="" width="563"><figcaption></figcaption></figure>

The private key needs to be in the standard PEM. In case your private key is in PuTTY .ppk format, you first need to [convert it as described here](https://www.ssh.com/academy/ssh/putty/mac#how-to-use-putty-ssh-keys-with-the-built-in-openssh).

Furthermore, the private key should not contain a passphrase.

## Actions&#x20;

### 1. Create Directory

<figure><img src="https://291121471-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-McrRFZHYH27bqKzOVDd%2Fuploads%2FDcXLpKG49oOM0kSHoHmp%2Fimage.png?alt=media&#x26;token=5619bff1-945a-4ceb-9d58-011d1d879f73" alt="" width="375"><figcaption></figcaption></figure>

To create a directory, provide the path of the new directory

### 2. List files and directories

<figure><img src="https://291121471-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-McrRFZHYH27bqKzOVDd%2Fuploads%2F0brAIXmzHllHV4RkIub4%2Fimage.png?alt=media&#x26;token=c70cebc3-f348-4665-879a-ae761561fda2" alt="" width="375"><figcaption></figcaption></figure>

To list FTP files in a directory, link to the directory.

### 3. Read a file

<figure><img src="https://291121471-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-McrRFZHYH27bqKzOVDd%2Fuploads%2F9guSvW88N5PpkMK1IC1U%2Fimage.png?alt=media&#x26;token=0c27beac-098b-46ad-b5d1-d032e40b0c15" alt="" width="375"><figcaption></figcaption></figure>

To read (download) an FTP file, link to the file by entering the path.

### 4. Upload a file

<figure><img src="https://291121471-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-McrRFZHYH27bqKzOVDd%2Fuploads%2Fjc8QpzcjQ9qg6biEaQvL%2Fimage.png?alt=media&#x26;token=b92ce4cb-8e5b-4e36-ab74-6f3b1a6a6a4c" alt="" width="375"><figcaption></figcaption></figure>

1. To upload a file, link to the location including the full file name to be used for the finishing file.
2. Next, link to the source file, where the file to be uploaded is located.

### 5. Move a file

<figure><img src="https://291121471-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-McrRFZHYH27bqKzOVDd%2Fuploads%2FGxdSkjRnDOD1rFWTfhR9%2Fimage.png?alt=media&#x26;token=a71d650c-3d10-4f1e-82c0-803eeca7f77e" alt="" width="375"><figcaption></figcaption></figure>

1. Enter the path to the file to be moved.
2. Enter the path to where the file should be moved.

### 6. Read Metadata

<figure><img src="https://291121471-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-McrRFZHYH27bqKzOVDd%2Fuploads%2FTwtnKwTZtVwh1MWw3DYn%2Fimage.png?alt=media&#x26;token=e084497b-b4ce-40dc-9344-3e0e5a39e0e4" alt="" width="375"><figcaption></figcaption></figure>

To read the metadata of an FTP file or directory, link to the file or directory by entering the path.

### 7. Delete File

<figure><img src="https://291121471-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-McrRFZHYH27bqKzOVDd%2Fuploads%2FyeBMozYY6gIhn3Ew45xw%2Fimage.png?alt=media&#x26;token=376c64e3-31e8-44c0-a7fc-78917ab09e46" alt="" width="375"><figcaption></figcaption></figure>

Enter the path to the file to be deleted.
