> For the complete documentation index, see [llms.txt](https://doc.wearepatchworks.com/product-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.wearepatchworks.com/product-documentation/process-flows/building-process-flows/process-flow-shapes/standard-shapes/connector-shape/configuring-sftp-connections/valid-ftp-commands/rename-ftp-command.md). # rename (FTP command) ### Overview The `rename` command changes the name of specified files. You can [rename single/multiple files and leave them in the same directory](#renaming-but-not-moving-a-file), or you can [rename files into a different directory](#renaming-and-moving-a-file). ## Need to know * No content is loaded into the flow. A boolean value is returned to indicate a successful/failed file operation. * Regular expressions are supported in filenames. ## Connection settings When [configuring an SFTP connector](/product-documentation/process-flows/building-process-flows/process-flow-shapes/standard-shapes/connector-shape/configuring-sftp-connections.md), three fields should be updated: | FTP command | Root | Path | | --------------------------------------------------------------------------------------- | ------------------------------------------------- | ----------------------------------------------- | | FTP command followed by the required directory and name for the file when it's renamed. | The common root to source and target directories. | The source directory and file(s) to be renamed. | ## Examples * [Rename but don't move a file](#renaming-but-not-moving-a-file) * [Rename & move a file](#renaming-and-moving-a-file) ### Renaming but not moving a file * [Scenario](#scenario) * [The steps](#the-steps) #### Scenario
Cover image

Our process flow is configured as below:

/files/rI8jPerjv9MFfSCvdBbq

In this flow, we need to rename a file named hello.txt in /myfiles/folderC to goodbye.txt:

We want the renamed file to end up in the same directory.

/files/2vpVY6Q37YrYqTgeZirK
#### The steps
Cover image

Connector settings

Our SFTP shape is configured as follows:

  • Use the SFTP GET user pass endpoint.
  • Start looking for the file to rename from the root, which is defined as: /myfiles/
  • Check the path for the file to rename, which is defined as: folderC/hello.txt
  • Rename the file to the directory/name provided immediately after the ftp command. This is defined as: rename:folderC/goodbye.txt
/files/oMb9sRQ3X0NcUlY4i8Mk

Payload & SFTP server

When the process flow is run, the payload for our SFTP shape shows just a 1:

A 1 indicates a successful response from your remote server. A 0 indicates an unsuccessful response.

On our remote server, hello.txt is now named goodbye.txt (still in /folderC):

/files/J6YFhcQQMgUmK2sBQwdu
### Renaming & moving a file * [Scenario](#scenario) * [The steps](#the-steps) #### Scenario
Cover image

Our process flow is configured as follows:

/files/rI8jPerjv9MFfSCvdBbq
In this flow, we need to rename /myfiles/folderE/hello.txt:



The file will be renamed as /myfiles/folderF/goodbye.txt - so we are both moving and renaming the file:

/files/2vpVY6Q37YrYqTgeZirK
#### The steps
Cover image

Connector settings for SFTP shape

Our first SFTP connector step is configured as follows:

  • Use the SFTP GET user pass endpoint.
  • Start looking for the file to rename from the root, which is defined as: /myfiles/
  • Check the path for the file to rename, which is defined as: folderE/hello.txt
  • Rename the file to the directory/name provided immediately after the ftp command. This is defined as: rename:folderF/goodbye.txt
/files/oMb9sRQ3X0NcUlY4i8Mk

Payload for SFTP shape
When the process flow is run, the payload for our SFTP shape shows just a 1:

A 1 indicates a successful response from your remote server. A 0 indicates an unsuccessful response.



/files/J6YFhcQQMgUmK2sBQwdu

Remote server outcome

On our remote server, hello.txt is gone from /myfiles/folderE:


But now we have a file named, goodbye.txt in /myfiles/folderF:


/files/CaDlvrcB9Vd1DmUVmK9d