List tasks

GET

/workflow

List all background tasks triggered by current authenticated user.

Request

Authorization

Add the parameter

Authorization

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

Example:

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

Query Params

page_size

integer

required

>= 10<= 100

Example:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

data

object (TaskListResponse)

required

pagination

object

required

tasks

array[object (TaskResponse) {12}]

required

code

integer

required

Response code.
0 - Success.

Default:

Example:

msg

string

optional

Human readable error message (if any).

Examples

General background tasksCompleted remote download tasksDownloading remote download tasks

{
    "code": 0,
    "data": {
        "tasks": [
            {
                "created_at": "2025-04-26T09:57:59+08:00",
                "updated_at": "2025-04-26T09:58:30+08:00",
                "id": "W6AmTK",
                "status": "completed",
                "type": "relocate",
                "summary": {
                    "phase": "finish",
                    "props": {
                        "dst_policy_id": "VecA",
                        "failed": 0,
                        "src_multiple": [
                            "cloudreve://my/1/cloudreve_4.0.0-beta.6_darwin_arm64.tar.gz"
                        ]
                    }
                },
                "duration": 19806,
                "resume_time": 1745632709
            },
            {
                "created_at": "2025-03-16T21:17:50+08:00",
                "updated_at": "2025-03-16T21:18:18+08:00",
                "id": "WqV7iK",
                "status": "completed",
                "type": "create_archive",
                "node": {
                    "id": "xmhb",
                    "name": "Master",
                    "type": "master",
                    "capabilities": "Hg=="
                },
                "summary": {
                    "phase": "upload_archive",
                    "props": {
                        "dst": "cloudreve://my/1/archive2.zip",
                        "failed": 1,
                        "src_multiple": [
                            "cloudreve://my/1/ad"
                        ]
                    }
                },
                "duration": 65,
                "resume_time": 1742131087
            },
            {
                "created_at": "2025-03-16T20:06:18+08:00",
                "updated_at": "2025-03-16T20:06:19+08:00",
                "id": "5EgBfy",
                "status": "error",
                "type": "extract_archive",
                "node": {
                    "id": "xmhb",
                    "name": "Master",
                    "type": "master",
                    "capabilities": "Hg=="
                },
                "summary": {
                    "props": {
                        "dst": "cloudreve://my/0/1/2/3/4/5/6/7/8/9/Q3%E5%A4%B4%E8%84%91%E9%A3%8E%E6%9A%B4",
                        "src": "cloudreve://my/0/1/2/3/4/5/6/7/8/9/Q3%E5%A4%B4%E8%84%91%E9%A3%8E%E6%9A%B4/archive2.zip"
                    }
                },
                "error": "file size 22693848 exceeds the limit 10485760 (non-retryable error)",
                "duration": 13
            }
        ],
        "pagination": {
            "page": 0,
            "page_size": 25,
            "is_cursor": true
        }
    },
    "msg": ""
}

Modified at 2025-06-27 03:12:07

Cancel task

Get task progress