FTP

FTP

The File Transfer Protocol (FTP) is a standard network protocol used to transfer computer files between a client and server on a computer network. FTP is built on a client-server model architecture and uses separate control and data connections between the client and the server.

The FTP Connector requires that the FTP Server be accessible from the cloud and set up to accept PASSIVE mode.

Trigger limits

The triggers work by polling the FTP file system, and looking for any file which has been modified since the last poll. Certain tools allow the file modification time to be preserved. In such cases, you need to disable the feature for your trigger to work. Here are some common settings:

FTP client Action
WinSCP Options → Preferences… → Transfer → Edit… → Preserve timestamp → Disable
FileZilla Transfer → Preserve timestamps of transferred files → Disable

When the triggers encounter a new file, it will try to ensure that the new file is completely written. For instance, it is possible that the file is being written or modified, and updates are being made at the time the trigger polled the file server. To avoid returning a file with partial content, the trigger will take note of the timestamp such files which are modified recently, but will not immediately return those files. Those files will be returned only when the trigger polls again. Sometimes, this may lead a delay up to twice the trigger polling interval.

The trigger "When a file is added or modified" doesn't pick up files over 50MB if the content is asked for. If files over 50MB should be processed with retrieving the content, the trigger "When a file is added or modified (properties only)" can be used followed by the "Get file content" operation.

Throttling Limits

Name Calls Renewal Period
API calls per connection 900 60 seconds

Creating a connection

To connect your account, you will need the following information:

Server Address
string
Server Address
User Name
string
User Name
Password
securestring
Password
FTP Server Port
int
FTP Port Number (example: 21)
Enable SSL?
bool
Enable SSL? (True/False)
Binary Transport?
bool
Enable Binary Transport? (True/False)
Disable Certificate Validation?
bool
Disable Certificate Validation? (True/False)

Actions

Copy file

This operation copies a file to an FTP server.

Required Parameters

Source url
string
Url to source file
Destination file path
string
Destination file path, including target filename

Optional Parameters

Overwrite?
boolean
Overwrites the destination file if set to 'true'

Returns

Body
BlobMetadata

Blob metadata

Create file

This operation creates a file.

Required Parameters

Folder path
string
Select a folder
File name
string
Name of the file
File content
binary
Content of the file

Returns

Body
BlobMetadata

Blob metadata

Delete file

This operation deletes a file.

Required Parameters

File
string
Select a file

Returns

Body
BlobMetadata

Blob metadata

Extract archive to folder

This operation extracts an archive file into a folder (example: .zip).

Required Parameters

Source archive file path
string
Path to the archive file
Destination folder path
string
Path to the destination folder

Optional Parameters

Overwrite?
boolean
Overwrites the destination files if set to 'true'

Returns

array of BlobMetadata

Get file content

This operation gets the content of a file.

Required Parameters

File
string
Select a file

Optional Parameters

Infer Content Type
boolean
Infer content-type based on extension

Returns

File Content
binary

The content of the file.

Get file content using path

This operation gets the content of a file using the file path.

Required Parameters

File path
string
Select a file

Optional Parameters

Infer Content Type
boolean
Infer content-type based on extension

Returns

File Content
binary

The content of the file.

Get file metadata

This operation gets the metadata for a file.

Required Parameters

File
string
Select a file

Returns

Body
BlobMetadata

Blob metadata

Get file metadata using path

This operation gets the metadata of a file using the file path.

Required Parameters

File path
string
Select a file

Returns

Body
BlobMetadata

Blob metadata

List files in folder

This operation gets the list of files and subfolders in a folder.

Required Parameters

Folder
string
Select a folder

Returns

array of BlobMetadata

List files in root folder

This operation gets the list of files and subfolders in the root folder.

Required Parameters

Source url
string
Url to source file
Destination file path
string
Destination file path, including target filename

Optional Parameters

Overwrite?
boolean
Overwrites the destination file if set to 'true'

Returns

array of BlobMetadata

Update file

This operation updates a file.

Required Parameters

File
string
Select a file
File content
binary
Content of the file

Returns

Body
BlobMetadata

Blob metadata

Triggers

When a file is added or modified

This operation triggers a flow when a file is added or modified in a folder. The trigger will fetch both the file metadata as well as the content of the file.

Required Parameters

Folder
string
Select a folder

Optional Parameters

Include file content
boolean
If set to true, file content will also be retrieved along with the trigger response
Infer Content Type
boolean
Infer content-type based on extension

Returns

File Content
binary

The content of the file.

When a file is added or modified (properties only)

This operation triggers a flow when one or more files are added or modified in a folder. This trigger will only fetch the file metadata. To get the file content, you can use the "Get file content" operation.

Required Parameters

Folder
string
Select a folder

Returns

List of Files
BlobMetadata

Blob metadata

Definitions

BlobMetadata

Blob metadata

DisplayName
string
The display name of the file or folder.
ETag
string
The etag of the file or folder.
FileLocator
string
The filelocator of the file or folder.
Id
string
The unique id of the file or folder.
IsFolder
boolean
A boolean value (true, false) to indicate whether or not the blob is a folder.
LastModified
date-time
The date and time the file or folder was last modified.
MediaType
string
The media type of the file or folder.
Name
string
The name of the file or folder.
Path
string
The path of the file or folder.
Size
integer
The size of the file or folder.