---
sourceDocument: Australia Workflow Data Fabric
sourceDocumentLink: https://www.servicenow.com/docs/r/australia/integrate-applications

 Release :

    - australia

ft:locale :

    - en-US

ft:publication_title :

    - Australia Workflow Data Fabric

ft:clusterId :

    - crint

bundleId :

    - crint

workflow :

    - Creator


---

# FTP connector methods

# FTP connector methods {#ariaid-title1}

Release version: Australia  
Updated March 12, 2026  
![](https://www.servicenow.com/docs/portal-asset/ico-clock) 4 minutes to read
Summarize  
![AI sparkle icon](https://servicenow.com/docs/portal-asset/ai-sparkle-icon) Summarized using AI  
This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.  

## Summary of FTP Connector Methods

The FTP connector methods allow you to interact with an FTP server as part of automation processes.
To utilize these methods effectively, you must provide specific parameters to configure server access and perform various actions such as creating, deleting, downloading, and uploading files or folders.
Show full answer Show less  

## Key Features

* **SetConfiguration:** Establishes connection details to the FTP server. Mandatory parameters include URL, username, and password.
* **CreateFolder:** Creates a specified folder on the FTP server. Requires the folder name as input.
* **DeleteFile:** Deletes a specified file from the FTP server. Requires the path to the file.
* **DeleteFolder:** Deletes a specified folder from the FTP server. Requires the folder path.
* **DownloadFile:** Downloads a file from the FTP server to a local drive. Requires both the remote file path and local path.
* **DownloadFolder:** Downloads a folder from the FTP server to the local drive. Requires the remote folder path and local folder path.
* **GetFileList:** Retrieves a list of files from a specified folder on the FTP server.
* **RenameFile:** Renames an existing file on the FTP server. Requires the current file path and the new name.
* **RenameFolder:** Renames an existing folder on the FTP server. Requires the current folder path and the new name.
* **UploadFile:** Uploads a file from the local drive to the FTP server. Requires the local file path and the destination path on the server.
* **UploadFolder:** Uploads a folder from the local drive to the FTP server. Requires both the local folder path and the destination folder path on the server.

## Key Outcomes

By utilizing these FTP connector methods, you can automate file management tasks efficiently, ensuring seamless integration and management of files and folders on your FTP server. This capability enhances productivity by streamlining processes such as data transfer and organization within your ServiceNow environment.  
The FTP connector methods perform various actions on the File Transfer Protocol server as part of an automation. To enable the methods, you
must provide appropriate parameters.

## SetConfiguration {#ftp-connector-methods__section_zqr_nbk_4tb}

Sets the File Transfer Protocol server access details. You must execute this
method first.

To provide inputs to the parameters, see [Configure port properties](https://www.servicenow.com/docs/o6fErdzBCUqYUWlLG1ZZzQ "Configure how data is passed to the input fields of a component or method in RPA Desktop Design Studio.").  
{#ftp-connector-methods__table_vbt_5zy_mtb__entry__6}

| Parameter | Description | Data port type | Data type | Default value | Mandatory? |
|-|-|-|-|-|-|
| Url | URL of the File Transfer Protocol | Data in | String | None | Yes |
| Username | Username to access the File Transfer Protocol server. | Data in | String | None | Yes |
| Password | Password to access the File Transfer Protocol server. | Data in | String | None | Yes |
[Table 1. SetConfiguration method parameters]

{#ftp-connector-methods__table_vbt_5zy_mtb}

## CreateFolder {#ftp-connector-methods__section_jcy_jdk_4tb}

Creates a folder on the File Transfer Protocol server.

To provide inputs to the parameters, see [Configure port properties](https://www.servicenow.com/docs/o6fErdzBCUqYUWlLG1ZZzQ "Configure how data is passed to the input fields of a component or method in RPA Desktop Design Studio.").  
{#ftp-connector-methods__table_my4_tdk_4tb__entry__6}

| Parameter | Description | Data port type | Data type | Default value | Mandatory? |
|-|-|-|-|-|-|
| FolderName | Path in the File Transfer Protocol server where the folder will be created with the folder name. | Data in | String | None | Yes |
| Return | Returns True if the folder is created, else, returns False. | Data out | Boolean | None | Not applicable |
[Table 2. CreateFolder method parameters]

{#ftp-connector-methods__table_my4_tdk_4tb}

## DeleteFile {#ftp-connector-methods__section_lbv_5pk_4tb}

Deletes a file in the FTP server.

To provide inputs to the parameters, see [Configure port properties](https://www.servicenow.com/docs/o6fErdzBCUqYUWlLG1ZZzQ "Configure how data is passed to the input fields of a component or method in RPA Desktop Design Studio.").  
{#ftp-connector-methods__table_ktb_gqk_4tb__entry__6}

| Parameter | Description | Data port type | Data type | Default value | Mandatory? |
|-|-|-|-|-|-|
| RemoteFilePath | Path to the file you want to remove in the File Transfer Protocol server. | Data in | String | None | Yes |
| Return | Returns True if the file is deleted, else, returns False. | Data out | Boolean | Not applicable | Not applicable |
[Table 3. DeleteFile method parameters]

{#ftp-connector-methods__table_ktb_gqk_4tb}

## DeleteFolder {#ftp-connector-methods__section_r4p_bkl_4tb}

Deletes the specified folder in the File Transfer Protocol server.

To provide inputs to the parameters, see [Configure port properties](https://www.servicenow.com/docs/o6fErdzBCUqYUWlLG1ZZzQ "Configure how data is passed to the input fields of a component or method in RPA Desktop Design Studio.").  
{#ftp-connector-methods__table_lxk_hkl_4tb__entry__6}

| Parameter | Description | Data port type | Data type | Default value | Mandatory? |
|-|-|-|-|-|-|
| RemoteFolderPath | Path to the folder in the File Transfer Protocol server including the folder name. | Data in | String | None | Yes |
| Return | Returns True if the folder is deleted, else, returns False. | Data out | Boolean | Not applicable | Not applicable |
[Table 4. DeleteFolder method parameters]

{#ftp-connector-methods__table_lxk_hkl_4tb}

## DownloadFile {#ftp-connector-methods__section_wsj_wkl_4tb}

Downloads a file from the File Transfer Protocol server to the local
drive.

To provide inputs to the parameters, see [Configure port properties](https://www.servicenow.com/docs/o6fErdzBCUqYUWlLG1ZZzQ "Configure how data is passed to the input fields of a component or method in RPA Desktop Design Studio.").  
{#ftp-connector-methods__table_wyp_kll_4tb__entry__6}

| Parameter | Description | Data port type | Data type | Default value | Mandatory? |
|-|-|-|-|-|-|
| RemoteFile | Path to the file in the File Transfer Protocol and the name of the file. | Data in | String | None | Yes |
| LocalFile | Path in the local drive where the file will be downloaded. | Data in | String | None | Yes |
| TimeOut | Time after which the request to the File Transfer Protocol server times out. | Data in | Integer | None | No |
| Return | Returns True if the file is downloaded, else, returns False. | Data out | Boolean | None | Not applicable |
[Table 5. DownloadFile method parameters]

{#ftp-connector-methods__table_wyp_kll_4tb}

## DownloadFolder {#ftp-connector-methods__section_wyq_tml_4tb}

Downloads a folder from the File Transfer Protocol server to the local
drive.

To provide inputs to the parameters, see [Configure port properties](https://www.servicenow.com/docs/o6fErdzBCUqYUWlLG1ZZzQ "Configure how data is passed to the input fields of a component or method in RPA Desktop Design Studio.").  
{#ftp-connector-methods__table_p2m_cnl_4tb__entry__6}

| Parameter | Description | Data port type | Data type | Default value | Mandatory? |
|-|-|-|-|-|-|
| RemoteFolderPath | Path to the folder in the File Transfer Protocol and the name of the folder. | Data in | String | None | Yes |
| LocalFolderPath | Path in the local drive where the folder will be downloaded. | Data in | String | None | Yes |
| TimeOut | Time after which the request to the File Transfer Protocol server times out. | Data in | Integer | None | No |
| Return | Returns True if the folder is downloaded, else, returns False. | Data out | Boolean | None | Not applicable |
[Table 6. DownloadFolder method parameters]

{#ftp-connector-methods__table_p2m_cnl_4tb}

## GetFileList {#ftp-connector-methods__section_yls_qnl_4tb}

Returns the list of files in a folder in the File Transfer Protocol
server.

To provide inputs to the parameters, see [Configure port properties](https://www.servicenow.com/docs/o6fErdzBCUqYUWlLG1ZZzQ "Configure how data is passed to the input fields of a component or method in RPA Desktop Design Studio.").  
{#ftp-connector-methods__table_gsx_c4l_4tb__entry__6}

| Parameter | Description | Data port type | Data type | Default value | Mandatory? |
|-|-|-|-|-|-|
| RemoteFolderPath | Path to the folder in the File Transfer Protocol and the name of the folder. | Data in | String | None | Yes |
| Return | Returns the list of files in the folder. | Data out | String | Not applicable | Not applicable |
[Table 7. GetFileList method parameters]

{#ftp-connector-methods__table_gsx_c4l_4tb}

## RenameFile {#ftp-connector-methods__section_hvm_vrl_4tb}

Renames a file in the File Transfer Protocol server.

To provide inputs to the parameters, see [Configure port properties](https://www.servicenow.com/docs/o6fErdzBCUqYUWlLG1ZZzQ "Configure how data is passed to the input fields of a component or method in RPA Desktop Design Studio.").  
{#ftp-connector-methods__table_a24_bsl_4tb__entry__6}

| Parameter | Description | Data port type | Data type | Default value | Mandatory? |
|-|-|-|-|-|-|
| RemoteFilePath | Path to the file in the File Transfer Protocol server and the name of the file. | Data in | String | None | Yes |
| NewNameofFile | Path to the file in the File Transfer Protocol server and the new name of the file. | Data in | String | None | Yes |
| Return | Returns True if the name of the file is changed, else, it returns False. | Data out | Boolean | Not applicable | Not applicable |
[Table 8. RenameFile method parameters]

{#ftp-connector-methods__table_a24_bsl_4tb}

## RenameFolder {#ftp-connector-methods__section_xyt_ysl_4tb}

Renames a folder in the File Transfer Protocol server.

To provide inputs to the parameters, see [Configure port properties](https://www.servicenow.com/docs/o6fErdzBCUqYUWlLG1ZZzQ "Configure how data is passed to the input fields of a component or method in RPA Desktop Design Studio.").  
{#ftp-connector-methods__table_a1c_ctl_4tb__entry__6}

| Parameter | Description | Data port type | Data type | Default value | Mandatory? |
|-|-|-|-|-|-|
| RemoteFolder | Path to the folder in the File Transfer Protocol server and the name of the folder. | Data in | String | None | Yes |
| NewNameofFolder | Path to the folder in the File Transfer Protocol server and the new name of the folder. | Data in | String | None | Yes |
| Return | Returns True if the name of the folder is changed, else, it returns False. | Data out | Boolean | Not applicable | Not applicable |
[Table 9. RenameFolder method parameters]

{#ftp-connector-methods__table_a1c_ctl_4tb}

## UploadFile {#ftp-connector-methods__section_uz4_4vl_4tb}

Uploads a file from the local drive to the File Transfer Protocol
server.

To provide inputs to the parameters, see [Configure port properties](https://www.servicenow.com/docs/o6fErdzBCUqYUWlLG1ZZzQ "Configure how data is passed to the input fields of a component or method in RPA Desktop Design Studio.").  
{#ftp-connector-methods__table_lxm_fyl_4tb__entry__6}

| Parameter | Description | Data port type | Data type | Default value | Mandatory? |
|-|-|-|-|-|-|
| LocalFilePath | Path to the file in the local drive. | Data in | String | None | Yes |
| RemoteFilePath | Path to the location in the File Transfer Protocol server. | Data in | String | None | Yes |
| Return | Returns True if the file is uploaded, else, returns False. | Data out | Boolean | Not applicable | Not applicable |
[Table 10. UploadFile method parameters]

{#ftp-connector-methods__table_lxm_fyl_4tb}

## UploadFolder {#ftp-connector-methods__section_pkp_5yl_4tb}

Uploads a folder from the local drive to the File Transfer Protocol
server.

To provide inputs to the parameters, see [Configure port properties](https://www.servicenow.com/docs/o6fErdzBCUqYUWlLG1ZZzQ "Configure how data is passed to the input fields of a component or method in RPA Desktop Design Studio.").  
{#ftp-connector-methods__table_djt_bzl_4tb__entry__6}

| Parameter | Description | Data port type | Data type | Default value | Mandatory? |
|-|-|-|-|-|-|
| LocalFolderPath | Path to the folder in the local drive. | Data in | String | None | Yes |
| RemoteFolderPath | Path to the location in the File Transfer Protocol server. | Data in | String | None | Yes |
| Return | Returns True if the folder is uploaded, else, returns False. | Data out | Boolean | Not applicable | Not applicable |
[Table 11. UploadFolder method parameters]

{#ftp-connector-methods__table_djt_bzl_4tb}