跳转到内容
Local API环境管理

编辑环境 ​

版本概览
PUT
/api/v1/browsers/{envId}

部分编辑当前用户、当前团队下的环境。只更新请求中明确提供的字段;运行中的环境可以保存,新配置在下次启动时生效。浏览器兼容条件变化时由后端重新生成内部 UA 字段,未修改的随机指纹值保持不变。

请求参数

Authorization Bearer Token

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

Authorization: Bearer <api-key>

Path 参数

1
字段说明
string必填
浏览器环境唯一标识
示例值"env_01JABCDEF1234567890"
minLength: 1

Body 参数

必填application/jsonBrowserUpdateRequest
字段说明
string
新的环境名称
minLength: 1maxLength: 32
object
需要修改的浏览器窗口尺寸

不允许额外字段。

object
内核、系统或 UA 兼容条件变化时重新生成内部 UA;null 用于恢复自动选择

不允许额外字段。

string | null
传 null 时移动到当前用户的默认分组
minLength: 1maxLength: 32
object[] | null
传 null 清空 Cookies;省略时保持原值
maxItems: 500
string | null
传 null 清空备注
maxLength: 5000
string | null
传 null 清空启动参数
maxLength: 5000
object
传 mode=none 取消代理;省略时保持原代理
string[]
覆盖已有账号绑定;传空数组清空绑定
maxItems: 100
object[]
创建账号并追加绑定到环境
minItems: 1maxItems: 20
string[]
覆盖手动扩展绑定;传空数组后仅保留全局扩展
maxItems: 100
object
需要修改的浏览器常用设置;未传的子字段保持原值

不允许额外字段。

object
需要修改的浏览器指纹配置;未传的子字段保持原值

不允许额外字段。

boolean
每次打开环境时是否重新随机指纹;省略时保持原值
示例

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

{
  "name": "string",
  "window": {
    "width": 0,
    "height": 0
  },
  "browser": {
    "kernel_version": "string",
    "system_os": "Windows",
    "system_version": "string",
    "ua_version": "string"
  },
  "group_id": "string"
}

请求示例代码

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

curl -X PUT -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' -d '{
  "name": "string",
  "window": {
    "width": 0,
    "height": 0
  },
  "browser": {
    "kernel_version": "string",
    "system_os": "Windows",
    "system_version": "string",
    "ua_version": "string"
  },
  "group_id": "string"
}' 'http://local.zhongyibrowser.com:39025/api/v1/browsers/env_01JABCDEF1234567890'

返回响应

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

更新后的环境标识和运行状态

Body

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

不允许额外字段。

示例

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

{
  "code": 0,
  "message": "success",
  "data": {
    "env_id": "env_01JABCDEF1234567890",
    "name": "string",
    "status": "active"
  }
}

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

中屹浏览器 Local API 文档