Patch metadata

PATCH

/file/metadata

Auth: JWT Optional

Modify metadata of the given file.

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.

>= 1 items

patches

array [object {3}]

required

List of metadata patches.

key

string

required

Metadata key. For patch operation, only a set of selected key prefixs are allowed:
sys:*,dav:*, customize:*, tag:*.

Example:

customize:icon_color

value

string | null

optional

Value of the metadata.

remove

boolean | null

optional

If set to true, metadata with given key will be removed.

Examples

Set folder icon colorRemove folder color customizationSet tags

{
    "uris": [
        "cloudreve://my/test_folder",
        "cloudreve://my/alit",
        "cloudreve://my/Inspirations"
    ],
    "patches": [
        {
            "key": "customize:icon_color",
            "value": "#d50000",
            "remove": false
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

cURL

Set folder icon colorRemove folder color customizationSet tags

curl --location --request PATCH '/file/metadata' \
--header 'X-Cr-Purchase-Ticket: 1f63aa26-edc0-40ce-950a-cb4d4323158e' \
--header 'Content-Type: application/json' \
--data-raw '{
    "uris": [
        "cloudreve://my/test_folder",
        "cloudreve://my/alit",
        "cloudreve://my/Inspirations"
    ],
    "patches": [
        {
            "key": "customize:icon_color",
            "value": "#d50000",
            "remove": false
        }
    ]
}'

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:14

Force unlock

Mount storage policy