Create direct links - 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

uris

array[string]

required

List of URI of the target files.

Example

{
    "uris": [
        "cloudreve://my/Inspirations/cloudreve_4.0.0-beta.7_windows_amd64.zip",
        "cloudreve://my/Inspirations/archive.zip"
    ]
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request PUT '/file/source' \
--header 'Content-Type: application/json' \
--data-raw '{
    "uris": [
        "cloudreve://my/Inspirations/cloudreve_4.0.0-beta.7_windows_amd64.zip",
        "cloudreve://my/Inspirations/archive.zip"
    ]
}'

Responses

🟢200Success

application/json

Body

data

array [object {2}] | null

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.

link

string

required

URL of the direct link.

file_url

string

required

URI of the target file.

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.

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

Examples

All successPartial success

{
    "code": 0,
    "data": [
        {
            "link": "http://localhost:5173/f/b8JH4/cloudreve_4.0.0-beta.7_windows_amd64.zip",
            "file_url": "cloudreve://my/Inspirations/cloudreve_4.0.0-beta.7_windows_amd64.zip"
        },
        {
            "link": "http://localhost:5173/f/8Qeue/archive.zip",
            "file_url": "cloudreve://my/Inspirations/archive.zip"
        }
    ],
    "msg": ""
}