Delete Folder
Deletes a folder, and everything in it, from an SFTP or FTP server.
Delete Folder removes a folder from your SFTP or FTP server, together with all the files and subfolders inside it.
Before you start
The action connects through an FTP credential that you create once in the Credential Manager (host, port, protocol FTP or SFTP, an optional Directory path, and a user name with a password or a key file). See FTP Credential.
Add the action
In the Process Designer toolbox, open SFTP and pick Delete Folder (or type Delete Folder in the search box).
Inputs and outputs
| Field | Direction | Type | Required | What to put / what you get |
|---|---|---|---|---|
| Select SFTP credentials | Input | FTP credential | Yes | The credential of the server. |
| Source Folder | Input | Text | No | The folder that contains the folder to delete, relative to the credential's Directory path. Leave empty for the root folder. |
| Folder Name | Input | Text | Yes | The name of the folder to delete. |
| Result | Output | Boolean | Yes | true if the folder was removed, false if not. |
Example
Source Folder archive, Folder Name 2024 โ archive/2024 and everything inside it are removed, and Result is true.
Everything under the folder is deleted, and this can't be undone. Check the values, especially when they come from variables.
Good to know
- Names are case-sensitive on most SFTP servers.
- If the server returns an error, the step fails with "Error while trying to delete folder".