跳转到内容
Local API代理管理

检测临时代理 ​

版本概览
POST
/api/v1/proxies/check

检测请求体中的 custom 或 api 临时代理配置,不创建代理,也不更新任何已保存代理。API 模式会先访问提取地址解析当前 IPv4 和端口;auth_type=credential 时使用 username/password 检测该连接,whitelist 时沿用原白名单逻辑。代理连接失败或超时属于正常检测结果,HTTP 200 响应中的 status 为 unavailable。本接口只需要 Local API Key,不依赖客户端后端登录态。

请求参数

Authorization Bearer Token

在请求头 Authorization 中使用 Bearer Token 传入 API Key。

Authorization: Bearer <api-key>

Body 参数

必填application/jsonProxyCheckRequest
字段说明
object
示例

根据数据模型生成,非实际请求结果。

{
  "mode": "custom",
  "config": {
    "host": "string",
    "port": 0
  }
}

请求示例代码

JavaScript / TypeScript 使用 Node.js 18+ 内置 fetch;PHP 需启用 cURL 扩展;Go 需 1.16+;Java 需 JDK 11+。运行前请替换 Token 和示例参数值。

curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' -d '{
  "mode": "custom",
  "config": {
    "host": "string",
    "port": 0
  }
}' 'http://local.zhongyibrowser.com:39025/api/v1/proxies/check'

返回响应

成功时 code = 0,失败时 code > 0。选择状态码查看对应字段和示例,展开对象可查看嵌套字段;可选字段可能不返回。

临时代理检测结果

Body

application/jsonProxyCheckSuccessResponse
字段说明
number必填
业务状态码;成功固定为 0
枚举值
string必填
业务状态信息;成功固定为 success
枚举值
object必填
接口业务数据

不允许额外字段。

示例

根据数据模型生成,非实际请求结果。

{
  "code": 0,
  "message": "success",
  "data": {
    "mode": "custom",
    "status": "available",
    "endpoint": {
      "protocol": "http",
      "ip_protocol": "ipv4",
      "host": "string",
      "port": 0
    },
    "checked_at": "2024-01-15T09:30:00Z",
    "latency_ms": 0
  }
}

查看全部业务错误码与 HTTP 状态码

中屹浏览器 Local API 文档