更新渠道配置

更新渠道

👨‍💼 需要管理员权限（Admin）

本地契约说明

路由：PUT /api/channel/

注册处理器：github.com/QuantumNous/new-api/controller.UpdateChannel。

消费方：web_vue。

鉴权：Admin + channel.write。要求 Admin 身份并由服务端验证 channel.write。部分敏感字段在 Controller 内二次要求 channel.sensitive_write。

字段状态：controller-confirmed-channel。字段为动态上游数据或回调负载时，文档会明确标记，不能补造 Schema。

页面/功能：渠道编辑抽屉保存渠道可编辑配置；状态切换必须使用专用接口。

前端传参：id 与要变更的 PatchChannel 字段；请求中禁止发送 status。更新 key、type、base_url、organization、override、setting、other、settings 或 key_mode 时需 channel.sensitive_write。

前端展示：显示更新后的渠道安全 DTO；服务端会清空返回的 key，并隐藏多密钥禁用原因和时间。

调试：使用本操作的 x-debug 里的占位符；示例不含真实密码、API Key、签名、Cookie 或 Provider 密钥。

请求参数

Authorization

Bearer Token

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

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

Body 参数application/json必填

示例

{
    "id": 12,
    "name": "debug-openai-updated",
    "models": "gpt-example,gpt-example-mini",
    "group": "default",
    "priority": 0,
    "key_mode": "replace"
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200

application/json

管理端业务响应。HTTP 200 不代表业务成功，必须检查 success。

Bodyapplication/json

示例

{
    "success": true,
    "message": "",
    "data": {
        "id": 12,
        "type": 1,
        "key": "",
        "status": 1,
        "name": "debug-openai-updated",
        "created_time": 1786650000,
        "test_time": 0,
        "response_time": 0,
        "balance": 12.34,
        "balance_updated_time": 1786650000,
        "models": "gpt-example,gpt-example-mini",
        "group": "default",
        "used_quota": 0,
        "other_info": "{}",
        "channel_info": {
            "is_multi_key": false,
            "multi_key_size": 0,
            "multi_key_status_list": {},
            "multi_key_polling_index": 0,
            "multi_key_mode": ""
        },
        "settings": "{}"
    }
}

🟠401

🟠403

更新渠道配置

本地契约说明#

请求参数

请求示例代码

返回响应

本地契约说明