FIfiles
file_actions
File Actions

Delete File/Folder and return its File Action. A pending or processing deletion continues in the background after this returns; check its File Migration for completion. Waiting for the File Migration does not cancel the deletion.

Changed on

Delete File/Folder and return its File Action. A pending or processing deletion continues in the background after this returns; check its File Migration for completion. Waiting for the File Migration does not cancel the deletion.

post/file_actions/delete/{path}

Request

  • Base URL
    https://app.files.com/api/rest/v1
  • URL
    https://app.files.com/api/rest/v1/file_actions/delete/{path}
  • Auth
    none declared

Path parameters

pathstring required

Path to operate on.

Request body multipart/form-data

recursiveboolean

If true, will recursively delete folders. Otherwise, will error on non-empty folders.

Response

The FileActions object.

statusstring

Status of file operation.

file_migration_idinteger

If status is pending, this is the id of the File Migration to check for status updates. Delete actions include it whenever the deletion runs as a File Migration, including while it is processing.

Example response

{
  "status": "pending",
  "file_migration_id": 1
}

Changes