Import external files - Cloudreve API Docs

Create a task to import external physical files to given path of a given user. This method is restricted to users with admin permission only.

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

src

string

required

Path of the folder to be imported in external storage provider.

dst

string

required

Path of the folder to store imported files in user's my filesystem.

Example:

/imported

extract_media_meta

boolean

optional

Whether to extract media metadata right after a file is imported.

user_id

string

required

ID of the user that files are imported to.

recursive

boolean

optional

Whether to recursively import child folders.

policy_id

integer

required

ID of the storage policy which have to be imported files.

Example

{
    "src": "/path/to/existing",
    "dst": "/",
    "extract_media_meta": false,
    "user_id": "lpua",
    "recursive": true,
    "policy_id": 1
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

data

object (TaskResponse)

required

created_at

string <date-time>

required

Example:

2025-04-22T17:13:06+08:00

updated_at

string <date-time>

required

Example:

2025-04-22T17:13:06+08:00

string

required

ID of the tasks.

Example:

LO5GtW

status

enum<string>

required

Status of the task

Allowed values:

queuedprocessingsuspendingerrorcanceledcompleted

Example:

completed

type

enum<string>

required

Allowed values:

media_metaentity_recycle_routineexplicit_entity_recycleupload_sentinel_checkcreate_archiveextract_archiverelocateremote_downloadimport

Example:

extract_archive

summary

object | null

optional

duration

integer | null

optional

Tasl executed duration in milliseconds.

Example:

1908

resume_time

integer | null

optional

Time stamp of the next expected resume time for suspended task.

Example:

1745313204

error

string | null

optional

Error message (if any).

error_history

array[string] | null

optional

List of error messages in previous retries (if any).

retry_count

integer | null

optional

Retry count.

node

object (Node)

required

Node of which this tasks is distributed onto.

code

integer

required

Response code.
0 - Success.

Default:

Example:

msg

string

optional

Human readable error message (if any).

Example

{
    "code": 0,
    "data": {
        "created_at": "2025-05-20T13:07:23.952911+08:00",
        "updated_at": "2025-05-20T13:07:23.952911+08:00",
        "id": "D8wbcA",
        "status": "queued",
        "type": "import",
        "summary": {
            "props": {
                "dst": "cloudreve://lpua@my/%2F",
                "dst_policy_id": "J7uV",
                "failed": 0,
                "src_str": "/not/exist"
            }
        }
    },
    "msg": ""
}