Create share link - Cloudreve API Docs

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

permissions

object (PermissionSetting)

required

Required in Pro edition. Permission setting of the share link.

user_explicit

object

optional

Map of explicit permission setting from user ID to boolset.

group_explicit

object

optional

Map of explicit permission setting from group ID to boolset.

same_group

string

optional

Permission for users under the same group as the file owner.

other

string

optional

Permission for users under the different groups as the file owner.

anonymous

string

optional

Permission for anonymous users.

Example:

AQ==

everyone

string

optional

Permission for everyone else.

Example:

AQ==

uri

string

required

URI of the shared file or folder.

is_private

boolean | null

optional

Whether this share link is protected with addition password and hidden in user's profile.

share_view

boolean | null

optional

Whether view settings within the shared folder is exposed to other user. If uri points to a file, this field is appliable.

expire

integer | null

optional

Number of seconds after which the link will be expired. Empty value means permanent link.

Example:

864000

price

integer | null

optional

Only in Pro edition. Set the price (in points) to pay for this link.

Example:

20

password

string | null

optional

Set custom share link password if is_private is true.

<= 32 characters

Example:

123123

Match pattern:

^[a-zA-Z0-9]+

show_readme

boolean | null

optional

Whether client UI should automatically render and shoe README.md file. Only for share folder.

Example

{
    "permissions": {
        "anonymous": "BQ==",
        "everyone": "AQ=="
    },
    "uri": "cloudreve://my/Inspirations",
    "is_private": true,
    "share_view": true,
    "expire": 604800,
    "price": 20
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request PUT '/share' \
--header 'Content-Type: application/json' \
--data-raw '{
    "permissions": {
        "anonymous": "BQ==",
        "everyone": "AQ=="
    },
    "uri": "cloudreve://my/Inspirations",
    "is_private": true,
    "share_view": true,
    "expire": 604800,
    "price": 20
}'

Responses

🟢200Success

application/json

Body

data

string | null

optional

URL of the share link. The formt is {siteURL}/s/{Share ID}/{Password}.

code

integer

required

Response code.
0 - Success.

Default:

0

Example:

0

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

Examples

Private sharePublic share

{
    "code": 0,
    "data": "http://localhost:5173/s/g2guA/gcqzfaze",
    "msg": ""
}