FTP and SFTP Connections

When you create or update an FTP or SFTP connection, you can configure additional attributes, such as the connection ID and the connection name.

The following table describes attributes that you can use for FTP or SFTP file connections:

Attribute

Description

id

Connection ID

orgid

Organization ID.

name

Connection name.

description

Optional connection description.

type

Connection type. Use CSVFile.

username

username

password

password

port

Network port number used to connect to FTP/SFTP connection. Default port is 21 for FTP and 22 for SFTP.

database

Directory on a local machine that stores the local file. In the user interface, this attribute is the Directory field. In the REST API response that populates the value in the user interface, the name of this attribute is dirName.
The local machine must also run the Secure Agent used to run the corresponding task. Enter a local directory or use the Browse button to select a local directory.

remoteDirectory

Directory on the FTP/SFTP host that stores the remote flat file.
Depending on the FTP/SFTP server, you may have limited options to enter directions. For more information, see the FTP/SFTP server documentation.

dataformat

Date format for date fields in the flat file. Use one of the following formats:
MM/dd/yyyy
MM-dd-yyyy
MM.dd.yyyy
dd/MM/yyyy
dd-MM-yyyy
dd.MM.yyyy
MM/dd/yyyy HH:mm
MM-dd-yyyy HH:mm
MM.dd.yyyy HH:mm
dd/MM/yyyy HH:mm
dd-MM-yyyy HH:mm
dd.MM.yyyy HH:mm
MM/dd/yyyy HH:mm:ss
MM-dd-yyyy HH:mm:ss
MM.dd.yyyy HH:mm:ss
dd/MM/yyyy HH:mm:ss
dd-MM-yyyy HH:mm:ss
dd.MM.yyyy HH:mm:ss
yyyy-MM-dd
yyyy-MM-dd HH:mm
yyyy-MM-dd HH:mm:ss
yyyy-MM-ddTHH:mm:ss.SSSZ
Default is MM/dd/yyyy HH:mm:ss.

codepage

The code page of the system that hosts the flat file. Use one of the following options:
UTF-8. Unicode Transformation Format, multibyte.
MS1252. MS Windows Latin 1 (ANSI), superset of Latin 1.
ISO-8859-15. Latin 9, Western European.
ISO-8859-2. Eastern European.
ISO-8859-3. Southeast European.
ISO-8859-5. Cyrillic.
ISO-8859-9. Latin 5, Turkish.
IBM500. IBM EBCDIC International Latin-1.

agentid

Secure Agent ID