Full path: /system/sftp/delete
Deletes a file from the SFTP Server.
This function returns Boolean true if the execution has been successful. Otherwise, the outcome depends on the Abort on error parameter, as further described below.
Parameters
Name |
Type |
Description |
|---|---|---|
SFTP Connection |
SFTP Connection |
A FlowForce object that provides the SFTP connection. To obtain the SFTP connection object, call the /system/sftp/connect function first, in a separate execution step.
Mandatory parameter. |
Target file |
string |
The file to delete. |
Abort on error |
boolean |
This Boolean parameter determines what should be the return value of the function if execution fails. If this parameter is false, the function will return Boolean false as well. If this parameter is true, the job execution is aborted. The default value is true. |
