Force unlock

DELETE

/file/lock

Auth: None

If a file is locked by other user/application, file mutation might fail with errors like below:

{
    "code": 40073,
    "data": [
        {
            "path": "cloudreve://my/newdfox.docx",
            "token": "cool-lock0a4b4f68",
            "owner": {
                "owner": "bnUn",
                "application": {
                    "type": "viewer",
                    "viewer_id": "af01b85b-f57d-46d2-8ad6-1d9b96548e78"
                }
            },
            "type": 0
        }
    ],
    "msg": "Lock conflict",
    "error": "conflict with locked resource: \"cloudreve://my/newdfox.docx\"",
    "correlation_id": "64210cda-5bd1-4fe1-9102-77b86f768395"
}

The lock token cool-lock0a4b4f68 in above example is only visable to file owners. This method can be used to force unlock files if the file owners wish to do so.

Request

Body Params application/json

tokens

array[string]

required

List of lock tokens, can be retrieved in lock conflict error response.

Example

{
    "tokens": [
        "string"
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request DELETE '/file/lock' \
--header 'Content-Type: application/json' \
--data-raw '{
    "tokens": [
        "string"
    ]
}'

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 04:09:33

Delete file

Patch metadata