Update file content

Update the content of given file, if it does not exit, a new file will be created with given content.

Request

Authorization

Add the parameter

Authorization

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

Example:

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

Query Params

uri

string

required

URI of the target file.

Example:

cloudreve://my/newfile.txt

string

optional

Previous version ID that the client side is aware of.
Similar to If-Match in HTTP reuqest, if this field is set:

If the file version matches, update will be performed;

If latest file version does not match this value, conflict error will be raised.

Example:

bOn4j

Header Params

Content-Length

integer

required

Length of the request body.

Example:

2164321

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/octet-stream

Not configured

Responses

🟢200Success

application/json

Body

data

object

required

Response content. In some error type, e.g. lock conflicting errors, this field wil present details of the error, e.g. who is locking the current file.

type

enum<integer>

required

Type of this file.

Allowed values:

string

required

ID of this file.

name

string

required

Name of this file.

It might not be expected display name. For files under trash bin, this field is a non-readable UUID. The expected display name should be retrieved from metadata with name sys:restore_uri, which can be parsed as a URI.

Example:

btn_google_signin_dark_normal_web@2x.png

permission

string | null

optional

Boolset encoded permissions granted by current authenticated user. For null, all permissions are granted.
Permission definition can be found at File Permissions

created_at

string <date-time>

required

Datetime when the file is created.

Example:

2025-05-24T10:55:22+08:00

updated_at

string <date-time>

required

Datetime when the file is last updated.

Example:

2025-05-24T10:55:22+08:00

size

integer

required

Size of the file, also the size of current primary version blob.

Example:

7536

path

string

required

URI of this file.

Example:

cloudreve://my/%E9%97%A8%E7%A5%A8/btn_google_signin_dark_normal_web%402x.png

capability

string | null

optional

Boolset encoded set of capabilities supported.

Example:

39/9

owned

boolean

required

Whether this file is owned by current authenticated user.

primary_entity

string | null

optional

ID of the primary version blob.

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,
    "data": {
        "type": 0,
        "id": "6ZeV3dUg",
        "name": "1234.md",
        "permission": null,
        "created_at": "2024-06-01T09:56:08+08:00",
        "updated_at": "2025-06-10T11:21:45+08:00",
        "size": 1775,
        "metadata": null,
        "path": "cloudreve://my/1234.md",
        "capability": "39/9AQ==",
        "owned": true,
        "primary_entity": "JBxJf5"
    },
    "msg": ""
}

Request

Request samples

Responses