创建下载器 - PeerBanHelper WebAPI

建议在创建/保存之前，先调用下载器测试接口，测试用户填写的配置有效再调用此接口。
当 DraftDownloader 中的 name 和请求 Param {downloadName} 不同时，PBH 会按照重命名处理，删除 downloadName 并添加 name

qBittorrent Config Example:

{
        "type": "qbittorrent",
        "endpoint": "http://localhost:58081",
        "username": "admin",
        "password": "adminadmin",
        "basicAuth": {
            "user": "",
            "pass": ""
        },
        "httpVersion": "HTTP_1_1",
        "incrementBan": false,
        "verifySsl": true,
        "ignorePrivate": false
    }

qBittorrentEE Config Example:

{
        "type": "qbittorrentee",
        "endpoint": "http://localhost:58081",
        "username": "admin",
        "password": "adminadmin",
        "basicAuth": {
            "user": "",
            "pass": ""
        },
        "httpVersion": "HTTP_1_1",
        "incrementBan": false,
        "useShadowBan": false,
        "verifySsl": true,
        "ignorePrivate": false
    }

Transmission Config Example:

{
        "type": "transmission",
        "endpoint": "http://localhost:58081",
        "username": "username",
        "password": "password",
        "httpVersion": "HTTP_1_1",
        "verifySsl": true,
        "rpcUrl": "/transmission/rpc",
        "ignorePrivate": false
    }

BiglyBT Config Example:

{
        "type": "biglybt",
        "endpoint": "http://localhost:58081",
        "token": "token",
        "httpVersion": "HTTP_1_1",
        "verifySsl": true,
        "ignorePrivate": false
    }

Deluge Config Example:

{
        "type": "deluge",
        "endpoint": "http://localhost:8112",
        "password": "deluge",
        "httpVersion": "HTTP_1_1",
        "incrementBan": false,
        "verifySsl": true,
        "rpcUrl": "/json",
        "ignorePrivate": false
    }

BitComet Config Example:

{
        "type": "bitcomet",
        "endpoint": "http://localhost:58081",
        "username": "admin",
        "password": "adminadmin",
        "httpVersion": "HTTP_1_1",
        "incrementBan": false,
        "verifySsl": true,
        "ignorePrivate": false
    }

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

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

Body 参数application/json

name

string

下载器名称

必需

避免使用特殊符号，建议过滤：字母、数字、下划线

config

object

JSON 配置块

必需

配置文件块，根据下载器的类型不同，其中的字段和参数可能均不相同

示例

{
    "name": "myqb",
    "config": "type: qbittorrent\nendpoint: http://localhost:58081\nusername: username\npassword: password\nbasic-auth:\n  user: ''\n  pass: ''\nhttp-version: HTTP_1_1\nincrement-ban: false\nverify-ssl: true\n"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢201成功

application/json

Body

message

string

提示信息

必需

test

boolean

测试是否通过

必需

示例

{
    "message": "Successfully to test the downloader",
    "test": true
}

🟠403未登录或Token错误

🟠429IP地址因频繁失败尝试而被封禁

🔴500内部服务器错误

🟠400参数有误