Extract archive - 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

src

array[string]

required

Source file URIs. Exact 1 item is expected.

>= 1 items<= 1 items

dst

string

required

URI of destination folder to store output files.

Example:

cloudreve://my/dst

preferred_node_id

string

optional

Select preferred node to handle this task. Only available in pro edition. Option of nodes can be get from List available nodes.

Example:

aO9z

encoding

string

optional

Encoding charset of the source archive file. By default it's utf8.

Example:

gb18030

Example

{
    "src": [
        "cloudreve://my/1/cloudreve_4.0.0-beta.7_windows_amd64.zip"
    ],
    "dst": "cloudreve://my/1",
    "preferred_node_id": "xmhb"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/workflow/extract' \
--header 'Content-Type: application/json' \
--data-raw '{
    "src": [
        "cloudreve://my/1/cloudreve_4.0.0-beta.7_windows_amd64.zip"
    ],
    "dst": "cloudreve://my/1",
    "preferred_node_id": "xmhb"
}'

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

id

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:

0

Example:

0

msg

string

optional

Human readable error message (if any).

Example

{
    "code": 0,
    "data": {
        "created_at": "2025-05-20T12:43:28.791573+08:00",
        "updated_at": "2025-05-20T12:43:28.791574+08:00",
        "id": "wzBlcG",
        "status": "queued",
        "type": "extract_archive",
        "summary": {
            "props": {
                "dst": "cloudreve://my/1",
                "src": "cloudreve://my/1/cloudreve_4.0.0-beta.7_windows_amd64.zip"
            }
        }
    },
    "msg": ""
}