FTP

Purpose

The FTP Operator enables file operations with FTP and FTPS servers. It provides functionality for listing, downloading, uploading, and deleting files on remote FTP servers, supporting both secure (FTPS) and standard FTP protocols.

Use Cases

• Transferring files between systems
• Backing up data to remote servers
• Retrieving data from legacy systems
• Automating file distribution workflows
• Integrating with systems that expose FTP interfaces
• Scheduled file synchronization
• Secure file transfer using FTPS

Supported Operations

list-files

Lists files and directories in the specified FTP directory.

Input Parameters

• host (string): The FTP server hostname
• port (integer): The FTP server port
• username (string): Username for authentication
• password (string): Password for authentication
• remotePath (string): The directory path on the FTP server to list
• secure (boolean): Whether to use secure FTPS connection

Output

Returns an FTPListOutput object containing an array of FTPFileInfo objects with the following properties:

• directory (boolean): Whether the item is a directory
• name (string): The file or directory name
• path (string): The full path of the file or directory
• size (long): The file size in bytes
• modificationTime (long): The last modification time as a timestamp
• accessTime (long): The last access time as a timestamp
• permissions (integer): The file permissions as a numeric mask

delete-file

Deletes a file from the FTP server.

Input Parameters

• host (string): The FTP server hostname
• port (integer): The FTP server port
• username (string): Username for authentication
• password (string): Password for authentication
• remotePath (string): The full path of the file to delete
• secure (boolean): Whether to use secure FTPS connection

Output

Returns a boolean indicating whether the deletion was successful.

download-file

Downloads a file from the FTP server.

Input Parameters

• host (string): The FTP server hostname
• port (integer): The FTP server port
• username (string): Username for authentication
• password (string): Password for authentication
• remotePath (string): The full path of the file to download
• secure (boolean): Whether to use secure FTPS connection

Output

Returns a FileDto object containing information about the downloaded file, including:

• id (string): The unique identifier of the file
• name (string): The file name
• contentType (string): The content type of the file
• size (long): The file size in bytes
• organizationId (string): The organization ID associated with the file

upload-file

Uploads a file to the FTP server.

Input Parameters

• host (string): The FTP server hostname
• port (integer): The FTP server port
• username (string): Username for authentication
• password (string): Password for authentication
• remotePath (string): The destination path on the FTP server
• secure (boolean): Whether to use secure FTPS connection
• file (FileDto): The file to upload, containing:
  • id (string): The unique identifier of the file
  • organizationId (string): The organization ID associated with the file

Output

Returns a boolean indicating whether the upload was successful.

Example

{
  "host": "ftp.example.com",
  "port": 21,
  "username": "ftpuser",
  "password": "password123",
  "remotePath": "/uploads/data.csv",
  "secure": true,
  "file": {
    "id": "file-123",
    "organizationId": "org-456"
  }
}