Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Adding documentation for the delete_file action
  • Loading branch information
JakePeralta7 authored Dec 8, 2023
1 parent 3825f2b commit c54608e
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -837,18 +837,20 @@ For best results, the <b>file path</b> 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
summary.total_objects_successful | numeric | | 1

0 comments on commit c54608e

Please sign in to comment.