Get share link info - Cloudreve API Docs

Get share link info from ID.

Request

Authorization

Add the parameter

Authorization

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

Example:

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

Path Params

string

required

ID of the share link. Can be parsed from Username part of the URI of the shared file or the short link created in Create share link

Example:

g2guA

Query Params

password

string

optional

Password of the share link for private share. Can be parsed from Password part of the URI of the shared file or the short link created in Create share link

Example:

gcqzfaze

count_views

boolean

optional

If set to true, the visited counter of the share link will be increased.

Example:

true

owner_extended

boolean

optional

If set to true and the requestor is the owner of the share, additional fields like source_uri will be available in the response.

Example:

true

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

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

data

optional

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.

Any of

null

If share link is not accessible to current user (unlocked is false), several fields wil be redacted.

string

required

ID of the share link.

Example:

VoMFL

name

string

optional

Name of the shared file/folder.

Example:

Shared folder

visited

integer

required

Count of views to this share link.

Example:

776

downloaded

integer

optional

Count of downloads to this share link. Only appliable to share links with a file(not folder) as source type.

Example:

price

integer

optional

Price of this share link, in points.

Example:

999

unlocked

boolean

required

Whether this share link is accessible to current user.

source_type

enum<integer>

optional

Type of the shared source file.

Allowed values:

Default:

owner

object

optional

Owner of this share link.

created_at

string <date-time>

optional

Create time.

expired

boolean

optional

Whether this link is already expired.

url

string

optional

URL of the share link.

Example:

http://cloudreve.org/s/VoMFL/2rje2bdj

permission_setting

object

optional

Only visable to owner. Permission setting for this share link.

is_private

boolean | null

optional

Only visable to owner. Whether this link is private (with password).

password

string

optional

Only visable to owner. Password of this share.

Example:

2rje2bdj

source_uri

string

optional

Only visable to owner, the File URI of the source file in owner's my filesystem.

Example:

cloudreve://lpua@my/BrNJdjbgi1mvqBf7zycSCskw6ky8nle0

share_view

boolean | null

optional

Only visable to owner, whether the explorer view setting is shared with others.

show_readme

boolean | null

optional

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

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": {
        "id": "g2guA",
        "name": "Inspirations",
        "visited": 0,
        "price": 20,
        "expires": "2025-06-17T16:16:39+08:00",
        "unlocked": true,
        "source_type": 1,
        "owner": {
            "id": "bnUn",
            "email": "luke@skywalker.com",
            "nickname": "Luke Skywalker",
            "avatar": "file",
            "created_at": "2023-08-06T19:21:59+08:00"
        },
        "created_at": "2025-06-10T16:16:39+08:00",
        "expired": false,
        "url": "http://localhost:5173/s/g2guA/gcqzfaze",
        "permission_setting": {
            "same_group": null,
            "everyone": "AQ==",
            "other": null,
            "anonymous": "BQ==",
            "group_explicit": {},
            "user_explicit": {}
        },
        "is_private": true,
        "password": "gcqzfaze",
        "share_view": true,
        "source_uri": "cloudreve://bnUn@my/Inspirations"
    },
    "msg": ""
}