Skip to content

Delete folder

Deletes the folder. Major version number will be incremented for delete folder operation.

Delete folder operation is eventually consistent. The specified folder is removed immediately, while its children are deleted in the background. A job ID is provided in the location header for tracking the progress of the deletion

In highly concurrent environments it is not guaranteed that all children will be marked as deleted. If active sub-folders creation and file upload is ongoing in the folder, those new and/or updated resources might stay active even after the job is completed, while parent folder will stay marked as deleted.

The following query parameters are available for the delete folder operation:

  • permanent - Folder can be deleted permanently by setting the permanent parameter to true. By default, folders are only soft deleted.

  • recursive - For deleting non-empty folder, recursive parameter needs to be specified as true.

Prerequisites

  • A folder should be created. To know more about creating a folder refer here

Request

DELETE {baseUrl}/spaces/{spaceId}/folders/{folderId}
  • HEADER:

    • Authorization: Bearer {tid token}

Response

Response Headers:
Location: /jobs/d5fdc7b4-5ddd-44f0-8129-7596895c6fa6

To know more about the Delete folder API refer here.