Delete Folders and Files#

Permanently deletes file or folder items. They are removed on the target node and changes propagated through the regular synchronization.

Endpoint#
 POST https://api.cloudplan.net/api/folder/delete

Request Parameters#

Possible request parameters#
{
    "node_id": "",
    "ff_id": "",
    "parent_id": ""
}

node_id | (string) (optional)

Content will be removed on this node and propagated to any other nodes. If left empty a suitable node is chosen automatically with priority on the private cloud nodes.

ff_id | (string)

Id of the item to remove. This can be a folder id or a file id. See List Folder Content for obtainting the index entries with their ids.

parent_id | (string)

Id of the parent folder for the given item.

Reply Parameters#

There are no reply parameters for this request. On failure errors may be returned.

Warning

If api returns timeout_db or a similar error, the target node may still have deleted the folder successfully. It is possible that the synchronization processes between node and server backend was too slow at that moment. Check the content on the nodes drive to be certain.

Example#

This request deletes a file with a specific target node.

Example request#
{
    "ff_id": "696E0525F62C01AB095421152ECAACC8",
    "node_id": "58B84023CC9C524F7441DAEE72BC9C73",
    "parent_id": "6319C982C7C0D952BFAA7347D212E57D"
}
Reply for the example request#
{
    "result": true
}