> Markdown versions of all pages of this connector library are available by appending `.md` to the page URL. For the full index of connectors, see [llms.txt](https://connectors.appmixer.com/llms.txt).

# FTP connector

- Connector: `appmixer.utils.ftp`
- Version: 1.4.2
- Components: 9 (1 trigger, 8 actions)

FTP Utilities.

- Connector page: <https://connectors.appmixer.com/connector/appmixer.utils.ftp/1.4.2>
- Documentation: <https://docs.appmixer.com/connector-configuration/utils/ftp>
- Source code: <https://github.com/clientIO/appmixer-connectors/tree/dev/src/appmixer/utils/ftp>
- Download package: <https://connectors.appmixer.com/connector/appmixer.utils.ftp/1.4.2/download>

## Authentication

**Type:** API Key

**Fields:**

- `Host` (text): Host, default "localhost".
- `Port` (text): Default 21. For SFTP the default is 22.
- `Username` (text): Username.
- `Password` (password): Password.
- `PrivateKey` (textarea): Private key; either use this or the password field. This only works with SFTP. PEM is the only supported format for keys that can be used.
- `Secure` (text): Default: "no". Use "yes" to set explicit FTPS over TLS. Use "implicit" if you need support for legacy implicit FTPS. Use "sftp" to set explicit SFTP over TLS.

## Triggers (1)

- [New File](https://connectors.appmixer.com/connector/appmixer.utils.ftp/1.4.2/component/appmixer.utils.ftp.NewFile.md) (`appmixer.utils.ftp.NewFile`): Watch for new files and folders.

## Actions (8)

- [Create Directory](https://connectors.appmixer.com/connector/appmixer.utils.ftp/1.4.2/component/appmixer.utils.ftp.CreateDirectory.md) (`appmixer.utils.ftp.CreateDirectory`): Create a directory.
- [Download File](https://connectors.appmixer.com/connector/appmixer.utils.ftp/1.4.2/component/appmixer.utils.ftp.DownloadFile.md) (`appmixer.utils.ftp.DownloadFile`): Download file from a remote FTP or SFTP server.
- [List](https://connectors.appmixer.com/connector/appmixer.utils.ftp/1.4.2/component/appmixer.utils.ftp.List.md) (`appmixer.utils.ftp.List`): List files and directories in the current working directory, or at path if specified.
- [Get File Info](https://connectors.appmixer.com/connector/appmixer.utils.ftp/1.4.2/component/appmixer.utils.ftp.GetFileInfo.md) (`appmixer.utils.ftp.GetFileInfo`): Get metadata of a file.
- [Remove Directory](https://connectors.appmixer.com/connector/appmixer.utils.ftp/1.4.2/component/appmixer.utils.ftp.RemoveDirectory.md) (`appmixer.utils.ftp.RemoveDirectory`): Remove a directory.
- [Remove File](https://connectors.appmixer.com/connector/appmixer.utils.ftp/1.4.2/component/appmixer.utils.ftp.RemoveFile.md) (`appmixer.utils.ftp.RemoveFile`): Remove a file.
- [Rename File](https://connectors.appmixer.com/connector/appmixer.utils.ftp/1.4.2/component/appmixer.utils.ftp.RenameFile.md) (`appmixer.utils.ftp.RenameFile`): Rename a file. Depending on the server you may also use this to move a file to another directory by providing full paths.
- [Upload File](https://connectors.appmixer.com/connector/appmixer.utils.ftp/1.4.2/component/appmixer.utils.ftp.UploadFile.md) (`appmixer.utils.ftp.UploadFile`): Upload file to a remote FTP or SFTP server.

## Changelog

### 1.4.2

- Security: upgraded basic-ftp to 6.2.4 (path traversal, CRLF command injection and denial-of-service advisories).

### 1.4.1

- Output examples for all FTP components.

### 1.4.0

- Added test() (Flow Test Mode) to triggers (NewFile).

### 1.3.3

- GetFileInfo now returns data for SFTP. Updated output properties to reflect either FTP or SFTP.

### 1.3.1

- Fix FTP authentication.

### 1.3.0

- Add option to authenticate with a private key when using SFTP.

### 1.2.1

- Fix DownloadFile component.

### 1.2.0

- Add handling of errors with status 550.
- The 'notFound' port added to some components.

### 1.1.4

- Get file info fixed.

### 1.1.3

- New file fixed.
- Port parameter fixed.

### 1.1.2

- GetFileInfo fixed.

### 1.1.1

- UploadFile tooltip enhanced, 553 error enhanced.

### 1.1.0

- Added SFTP support.
