Update view setting

PATCH

/file/view

Auth: JWT Required

Update view settings for given folder. Only owner of the folder can update view settings.

Request

Authorization

Add the parameter

Authorization

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

Example:

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

Body Params application/json

uri

string

required

URI of the target folder.

view

optional

View settings. Set value to null to clear existing view settings for target folder.

Any of

ExplorerView

null

page_size

integer

required

The number of items to display per page.

>= 50

order

string

optional

The field to order the results by.

<= 255 characters

order_direction

enum<string>

optional

The direction to order the results.

Allowed values:

ascdesc

view

enum<string>

optional

The view mode for the explorer.

Allowed values:

listgridgallery

thumbnail

boolean

optional

Whether to display thumbnails in grid view.

gallery_width

integer

optional

The width of a single item in gallery view.

>= 50<= 500

columns

array[object (ListViewColumn) {3}]

optional

The columns to display in the list view.

<= 1000 items

Example

{
    "uri": "cloudreve://my/Inspirations",
    "view": {
        "page_size": 50,
        "order": "updated_at",
        "order_direction": "desc",
        "view": "list",
        "thumbnail": true,
        "columns": [
            {
                "type": 0
            },
            {
                "type": 2
            },
            {
                "type": 8
            },
            {
                "type": 7
            }
        ],
        "gallery_width": 50
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH '/file/view' \
--header 'Content-Type: application/json' \
--data-raw '{
    "uri": "cloudreve://my/Inspirations",
    "view": {
        "page_size": 50,
        "order": "updated_at",
        "order_direction": "desc",
        "view": "list",
        "thumbnail": true,
        "columns": [
            {
                "type": 0
            },
            {
                "type": 2
            },
            {
                "type": 8
            },
            {
                "type": 7
            }
        ],
        "gallery_width": 50
    }
}'

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.

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": "anim adipisicing ullamco dolore et"
}

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

Mount storage policy

Create share link