Delete

This api will Delete entities from specific storage path.

Delete Api options

The options available in this api are described below:

Option name	Type	Default Value	Required	Description
Path	string			The storage path from which the entities are to be deleted
Include	string			Include entities matching pattern
Exclude	string			Exclude entities matching pattern
MinAge	string			Filter entities older than this in second or suffix ms | s | m | h | d | w | M | y
MaxAge	string			Filter entities younger than this in second or suffix ms | s | m | h | d | w | M | y
MinSize	string			Filter entities bigger than this in KiB or suffix B | K | M | G | T | P
MaxSize	string			Filter entities smaller than this in KiB or suffix B | K | M | G | T | P
CaseSensitive	bool	false		Ignore or apply case sensitive in filters
Recurse	bool	false		Apply recursion on filtering entities in the specified path

Calling Delete Api

For calling this api, the following details are required to apply:

note

The options and parameters introduced in the previous section must be included as json data in the request body part.

URL	Method	ContentType	Body
http://localhost:5860/storage/delete	DELETE	application/json	{ "path": <STRING VALUE>, "include": <STRING VALUE>, "exclude": <STRING VALUE>, "minAge": <STRING VALUE>, "maxAge": <STRING VALUE>, "minSize": <STRING VALUE>, "maxSize": <STRING VALUE>, "caseSensitive": <BOOLEAN VALUE>, "recurse": <BOOLEAN VALUE> }

Now, if we want to have these details in the form of an http api call, open a new terminal and enter the following command:

info

First of all make sure flowsynx is running.

HTTP API (Bash)

curl -X POST -H "Content-Type: application/json" -d '{ "path": "/path/", "include": "", "exclude": "", "minAge": "", "maxAge": "", "minSize": "", "maxSize": "", "caseSensitive": false, "recurse": true }' http://localhost:5860/storage/delete

HTTP API (PowerShell)

Invoke-RestMethod -Method Post -ContentType 'application/json' -Body '{ "path": "C:/path/", "include": "", "exclude": "", "minAge": "", "maxAge": "", "minSize": "", "maxSize": "", "caseSensitive": false, "recurse": true }' -Uri 'http://localhost:5860/storage/delete'

Also you can use Http Api test clients to test this api. Anyway, after executing this api, a result like below will be obtained.

{
  "data": null,
  "messages": [
    "The file(s) were deleted successfully."
  ],
  "succeeded": true
}

The answer is divided into three data, messages, and succeeded parts. succeeded indicates the status of the execution of this api which is boolean value and can be true or false. messages also indicates the list of possible messages that are returned with the response. data contains the data to be returned.