FTP Component

Manage files and directories on an FTP server

Component key: ftp

Description

The FTP component lets you upload, download, move and delete files on a FTP server.

A common integration pattern involves listing files in a file store, and performing a series of actions on the array of files that are returned. See our looping over files quickstart for information about how to create a loop over an array of files.

Authorization Notes

This component supports basic auth (username/password) and private key authentication, with basic auth being more common for FTP servers.

Actions

Delete File

Delete a file from a FTP server | key: deleteFile

Input	Key	Default	Notes	Example
Host string / Required	host		The address of the FTP server. This should be either an IP address or hostname.	ftp.prismatic.io
Path string / Required	path		Path of file to delete	/path/to/file.txt
Port string	port	21	The port of the FTP server.	21
Secure string	secure	false	Specifies whether to use FTPS over TLS. Can be true, false, or implicit, which is for legacy implicit FTPS.	false
Verbose Logging boolean	verbose	false	Specifies whether to enable verbose logging in the underlying FTP library, which may be useful for debugging.	false

Authorization

Authorization is not required for this action.

Auth Type	Key	Description	Fields
Basic Auth	basic	Basic authorization using a username/password combination	Username |  username Password |  password

---

List Directory

List the contents of a directory | key: listDirectory

Input	Key	Default	Notes	Example
Host string / Required	host		The address of the FTP server. This should be either an IP address or hostname.	ftp.prismatic.io
Path string / Required	path		Path of directory on FTP server to list	/path/to/directory
Port string	port	21	The port of the FTP server.	21
Secure string	secure	false	Specifies whether to use FTPS over TLS. Can be true, false, or implicit, which is for legacy implicit FTPS.	false
Verbose Logging boolean	verbose	false	Specifies whether to enable verbose logging in the underlying FTP library, which may be useful for debugging.	false

Authorization

Authorization is not required for this action.

Auth Type	Key	Description	Fields
Basic Auth	basic	Basic authorization using a username/password combination	Username |  username Password |  password

Output Example Payload

{  "data": [    {      "name": "example.txt",      "size": 123456,      "rawModifiedAt": "Wed, 01 Jan 2020 00:00:00 GMT",      "isDirectory": true,      "isSymbolicLink": true,      "isFile": true,      "date": "Wed, 01 Jan 2020 00:00:00 GMT"    }  ]}

---

Move File

Move a file on an FTP server | key: moveFile

Input	Key	Default	Notes	Example
Destination Path string / Required	destinationPath		Path of file to move	/my/destination/path.txt
Host string / Required	host		The address of the FTP server. This should be either an IP address or hostname.	ftp.prismatic.io
Port string	port	21	The port of the FTP server.	21
Secure string	secure	false	Specifies whether to use FTPS over TLS. Can be true, false, or implicit, which is for legacy implicit FTPS.	false
Source Path string / Required	sourcePath		Path of file to move	/my/starting/path.txt
Verbose Logging boolean	verbose	false	Specifies whether to enable verbose logging in the underlying FTP library, which may be useful for debugging.	false

Authorization

Authorization is not required for this action.

Auth Type	Key	Description	Fields
Basic Auth	basic	Basic authorization using a username/password combination	Username |  username Password |  password

---

Read File

Read a file from FTP | key: readFile

Input	Key	Default	Notes	Example
Host string / Required	host		The address of the FTP server. This should be either an IP address or hostname.	ftp.prismatic.io
Path string / Required	inputPath		Path of file on FTP server to read data from	/path/to/file.txt
Port string	port	21	The port of the FTP server.	21
Secure string	secure	false	Specifies whether to use FTPS over TLS. Can be true, false, or implicit, which is for legacy implicit FTPS.	false
Verbose Logging boolean	verbose	false	Specifies whether to enable verbose logging in the underlying FTP library, which may be useful for debugging.	false

Authorization

Authorization is not required for this action.

Auth Type	Key	Description	Fields
Basic Auth	basic	Basic authorization using a username/password combination	Username |  username Password |  password

Output Example Payload

{  "data": {    "type": "Buffer",    "data": [      101,      120,      97,      109,      112,      108,      101    ]  },  "contentType": "application/octet"}

---

Write File

Write a file to FTP | key: writeFile

Input	Key	Default	Notes	Example
Data text / Required	data		Text to write into the file
Host string / Required	host		The address of the FTP server. This should be either an IP address or hostname.	ftp.prismatic.io
Path string / Required	outputPath		Path on FTP server to write file	/we/love/commas.csv
Port string	port	21	The port of the FTP server.	21
Secure string	secure	false	Specifies whether to use FTPS over TLS. Can be true, false, or implicit, which is for legacy implicit FTPS.	false
Verbose Logging boolean	verbose	false	Specifies whether to enable verbose logging in the underlying FTP library, which may be useful for debugging.	false

Authorization

Authorization is not required for this action.

Auth Type	Key	Description	Fields
Basic Auth	basic	Basic authorization using a username/password combination	Username |  username Password |  password

---