Delete file

DELETE

/file

Auth: JWT Optional

Request

Authorization

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Header Params

X-Cr-Purchase-Ticket

string

optional

Can be used to authenticate to paid share links with a anonymous identity. The ticket value can be obtained after an anonymous user purchase a paid share link.

Example:

1f63aa26-edc0-40ce-950a-cb4d4323158e

Body Params application/json

uris

array[string]

required

List of URI of the target files.

unlink

boolean | null

optional

Whether to keep physical files while recycling file blobs. This option only works if the user group have "Advanced delete option` enabed.

skip_soft_delete

boolean | null

optional

Whether to skip trash bin, directly delete those files. This option only works file file owner or administrators.

Examples

Delete without trash binMove files to trash binDelete files in trash bin

{
    "uris": [
        "cloudreve://my/newfile.docx",
        "cloudreve://my/%E6%96%B0%E6%96%87%E4%BB%B6.txt",
        "cloudreve://my/%E7%BF%BB%E8%AF%91%E4%BD%9C%E4%B8%9A1.docx"
    ],
    "unlink": false,
    "skip_soft_delete": true
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

cURL

Delete without trash binMove files to trash binDelete files in trash bin

curl --location --request DELETE '/file' \
--header 'X-Cr-Purchase-Ticket: 1f63aa26-edc0-40ce-950a-cb4d4323158e' \
--header 'Content-Type: application/json' \
--data-raw '{
    "uris": [
        "cloudreve://my/newfile.docx",
        "cloudreve://my/%E6%96%B0%E6%96%87%E4%BB%B6.txt",
        "cloudreve://my/%E7%BF%BB%E8%AF%91%E4%BD%9C%E4%B8%9A1.docx"
    ],
    "unlink": false,
    "skip_soft_delete": true
}'

Responses

🟢200Success

application/json

Body

code

integer

required

Response code.
0 - Success.

Default:

Example:

msg

string

optional

Human readable error message (if any).

error

string | null

optional

Internal error message, only visable in debug mode.

aggregated_error

object | null

optional

Map of multiple error in batch request. The key is the failed resource ID, it could be a file URI or a resource ID, the value is a Response.

Additional properties

object (Response)

optional

correlation_id

string <uuid> | null

optional

Correlation ID of the request. Only presented on failed reqeust.

Example:

b4351ecc-ee1a-4455-bc94-2c3dbcc58538

Example

{
    "code": 0,
    "msg": ""
}

Modified at 2025-06-10 08:31:05

Restore from trash bin

Force unlock