FTP

Interact with files and directories on FTP servers

Component key: ftp

Description#

The FTP component lets you upload, download, move and delete files on a FTP server. This component supports basic auth (username/password) and private key authentication.

Authorization Methods#

FTP can use the following authorization methods, though no authorization method is required:

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

Auth Type

Key

Description

Fields

Basic Auth

basic

Basic authorization using a username/password combination

Password | password

Username | username

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

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

Output Example Payload#

{
  "data": [
    {
      "name": "example.txt",
      "size": "123456",
      "type": "txt",
      "rawModifiedAt": "2020-01-01T00:00:00.000Z",
      "UnixPermission": {
        "Read": 7,
        "Write": 7,
        "Execute": 7
      }
    }
  ]
}

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

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

Output Example Payload#

{
  "data": {
    "data": [
      101,
      120,
      97,
      109,
      112,
      108,
      101
    ],
    "type": "Buffer"
  },
  "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