From c54608e2345e9e8af510cf5e16ec8ec663ff553a Mon Sep 17 00:00:00 2001 From: Elad Levi <58475124+JakePeralta7@users.noreply.github.com> Date: Fri, 8 Dec 2023 20:40:55 +0200 Subject: [PATCH] Update README.md Adding documentation for the delete_file action --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b84bcf4..97e9d47 100644 --- a/README.md +++ b/README.md @@ -837,18 +837,20 @@ For best results, the file path parameter should be an absolute path to a PARAMETER | REQUIRED | DESCRIPTION | TYPE | CONTAINS --------- | -------- | ----------- | ---- | -------- **ip_hostname** | optional | IP/Hostname | string | `ip` `host name` -**file_path** | required | Path to file | string | `file path` +**file_path** | required | Path to file / directory | string | `file path` **force** | optional | Use the force flag for delete | boolean | +**recurse** | optional | Use the recurse flag to delete directory content recursively | boolean | #### Action Output DATA PATH | TYPE | CONTAINS | EXAMPLE VALUES --------- | ---- | -------- | -------------- action_result.parameter.file_path | string | `file path` | C:\\Windows\\System32\\notepad.exe action_result.parameter.force | boolean | | True False +action_result.parameter.recurse | boolean | | True False action_result.parameter.ip_hostname | string | `ip` `host name` | 8.8.8.8 8.8.8.8\\testphantom.local action_result.data | string | | action_result.status | string | | success failed action_result.message | string | | Successfully deleted files action_result.summary | string | | summary.total_objects | numeric | | 1 -summary.total_objects_successful | numeric | | 1 \ No newline at end of file +summary.total_objects_successful | numeric | | 1