1.获取环境列表

• Path：/api/v1/env/list
• Method： POST
• Content-Type：application/json
• 接口描述：查询环境的信息。用户仅能查询自己有权限的环境信息。

请求参数

请求示例

{
    "current": 1,
    "size": 200
}

执行成功返回

若环境内添加了帐号，会同时返回帐号信息

{
    "msg": "Success",
    "code": 0,
    "data": {
        "list": [
            {
                "allOpenTime": "10-19 17:51:11", 	//环境最后打开时间
                "asDynamicType": 1, 			//代理使用方式，1-静态，2-动态
                "containerCode": 8256337, 		//环境ID
                "containerName": "带cookie的阿基3",  //环境名称
                "createTime": "2022-09-14 17:12:20", //创建时间
                "lastCity": "London", 			//上一次IP的城市
                "lastCountry": "United Kingdom",  	//上一次IP的国家
                "lastRegion": "England", 		//洲或省的名称
                "lastUsedIp": "8.208.80.219", 		//上一次使用的IP
                "openTime": "2022-10-19 17:51:12", // 打开时间
                "proxyHost": "8.208.80.219", 		//代理主机
                "proxyPort": 32080, 			//代理端口号
                "proxyTypeName": "Socks5", 		// 代理类型
                "tagName": "小九九的分组" ,		//环境分组名称
                "tagCode": "XXXX",   //环境ID
                "ua": "XXXX"   //环境ua（仅支持3.39.0及以上客户端版本）
            },
            {
                "allOpenTime": "09-14 17:10:35",
                "asDynamicType": 1,
                "containerCode": 8256321,
                "containerName": "带cookie的阿基2",
                "createTime": "2022-09-14 17:04:11",
                "openTime": "2022-09-14 17:10:36",
                "proxyHost": "8.208.80.219 ",
                "proxyPort": 32080,
                "proxyTypeName": "Socks5",
                "referenceCountryCode": "smartproxy",
                "tagName": "小九九的分组",
                "tagCode": "XXXX",  
                "ua": "XXXX"  //环境ua（仅支持3.39.0及以上客户端版本）
            },

        ],
        "total": 2
    }
}

2.创建环境

• Path： /api/v1/env/create
• Method： POST
• Content-Type：application/json
• 接口描述：创建环境，支持配置环境的名称、备注、分组和代理信息。创建成功后返回环境ID。

请求参数
(默认新建的环境随机UA，且禁止加载图片视频）

请求示例

{
    "asDynamicType":"2",
    "containerName":"新建环境",
    "proxyTypeName":"不使用代理",
    "coreVersion":112,
    "advancedBo" : {
        "uaVersion":112,
        "uiLanguage":"en",
        "languages":["en", "en-US"]
    }
}

执行成功返回

{
    "requestId": "8b558e5c5d1c437183c34aa03a09a368",
    "msg": "Success",
    "code": 0,
    "data": {
        "containerCode": 50591754, //环境ID 
        "coreVersion": 100 //环境使用的内核版本，用于匹配对应版本的webdriver
    }
}

3. 更新环境

• Path： /api/v1/env/update
• Method： POST
• Content-Type：application/json
• 接口描述：修改环境参数，包括备注信息和分组名称。更新成功返回true。

请求参数

注：当前接口不支持 Cookie 更新和代理更新，使用对应的接口单独实现（详见本页4、6、7接口）

请求示例

{
    "containerCode":189603333,
    "containerName": "修改环境名"
}

执行成功返回

{ 
    "requestId": "68cb72ff72e9441da4fb84760937ead3", 
    "msg": "Success", 
    "code": 0, 
    "data": true 
}

4. 更新环境代理

• Path： /api/v1/env/proxy/update
• Method： POST
• Content-Type：application/json
• 接口描述：修改指定环境的代理信息，包括代理主机、端口、帐号、密码等。更新成功返回true。

请求参数

请求示例

{
    "containerCode":8294141,
    "asDynamicType":2,
    "proxyTypeName":"不使用代理"
}

执行成功返回

{ 
    "requestId": "ef10f8a4931b455889477bb3b34ff636", 
    "msg": "Success", 
    "code": 0, 
    "data": true 
}

5.删除环境

• Path： /api/v1/env/del
• Method： POST
• Content-Type：application/json
• 接口描述：删除指定环境。删除成功返回true。一次性最多支持删除环境1000个。

请求参数

请求示例

{
    "containerCodes":[132725138]
}

执行成功返回

{ 
    "requestId": "7cf821b221c34da7a99708e6947e3450", 
    "msg": "Success", 
    "code": 0, 
    "data": true 
}

6.导入Cookie

• Path： /api/v1/env/import-cookie
• Method： POST
• Content-Type：application/json
• 接口描述：向指定环境导入cookie，导入成功返回true。

请求参数
本期只支持hubstudio导出的cookie字符串

请求示例

{
    "containerCode":"132823764",
    "cookie":"[]"  // 值为[]是清空cookie
}

执行成功返回

{ 
    "requestId": "b4e67b308a6c4b5da2d9b1fcb9492761", 
    "msg": "Success", 
    "code": 0, 
    "data": true 
}

7.导出Cookie

• Path： /api/v1/env/export-cookie
• Method： POST
• Content-Type：application/json
• 接口描述： 导出指定环境的cookie，导出成功返回cookie的json串。

请求参数

请求示例

{
    "containerCode":"118969108"
}

执行成功返回

{ 
    "requestId": "0b1ef5b88e5942eb933c97982ba8492a", 
    "msg": "Success", 
    "code": 0, 
    "data": "[{\"Name\":\"CONSENT\",\"Value\":\"PENDING+571\",\"Domain\":\".google.com\",\"Path\":\"/\",\"Secure\":true,\"HttpOnly\":false,\"Persistent\":\"1\",\"Creation\":\"2022-09-14T15:18:07.389+08:00\",\"LastAccess\":\"2024-09-13T15:18:07.389+08:00\",\"Expires\":\"2024-09-13T15:18:07.389+08:00\",\"Priority\":\"1\",\"HasExpires\":\"1\",\"Samesite\":\"-1\",\"SourceScheme\":\"2\",\"Firstpartyonly\":\"\",\"schemeMap\":false,\"isSelf\":false}]" 
}

8.获取随机UA

• Path： /api/v1/env/random-ua
• Method： POST
• Content-Type：application/json
• 接口描述：获取随机UA，获取成功返回UA。

请求参数

请求示例

{
    "version":[112]
}

执行成功返回

{
    "requestId": "59e685a3775944e188545a10fb07e0e1",
    "msg": "Success",
    "code": 0,
    "data": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/112.0.5615.87 Safari/537.36"
}

9.清除环境本地缓存

• Path：/api/v1/cache/clear
• Method： POST
• Content-Type：application/json
• 接口描述：清除环境本地缓存

请求参数

请求示例

{
    "browserOauths": ["11509459", "11509427"]
}

执行成功返回

{
    "requestId": "d2feae4d-bc25-43d9-bfdd-8e1e9a56f618",
    "msg": "Success",
    "code": 0,
    "data": {
        "action": "ClearCache",
        "err": "成功",
        "failIds": [
            11509459
        ],
        "info": "清理缓存成功，11509427已清理，11509459已打开 无法清理",
        "requestId": "d2feae4d-bc25-43d9-bfdd-8e1e9a56f618",
        "statusCode": "0",
        "successIds": [
            11509427
        ]
    }
}

10.清理环境内插件缓存

• Path：/api/v1/browser/reset-extension
• Method： POST
• Content-Type：application/json
• 接口描述：清理环境内插件缓存，清理成功后插件的所有数据均会被删除
• 仅支持v3.3.0以上版本，请前往官网下载客户端最新版本【下载Hubstudio最新版】

请求示例

{
    "browserOauth": 33498,
    "pluginIds": ["hlkenndednhfkekhgcdicdfddnkalmdm","dagohlmlhagincbfilmkadjgmdnkjinl1"]
}

11.下载环境内核

• Path：/api/v1/browser/download-core
• Method： POST
• Content-Type：application/json
• 接口描述：下载环境内核
• 仅支持v3.19.0以上版本，请前往官网下载客户端最新版本【下载Hubstudio最新版】

请求示例

{
    "Cores":[
        {
            "BrowserType":1,
            "Version":"109"
        },
        {
            "BrowserType":2,
            "Version":"110"
        }
    ]
}

12.刷新指纹

• Path：/api/v1/env/refresh-fingerprint
• Method： POST
• Content-Type：application/json
• 接口描述：刷新指纹
• 仅支持v3.37以上版本，请前往官网下载客户端最新版本【下载Hubstudio最新版】

请求示例

{
    "containerCode": 11423751,
    "uaVersion": 131 ,
    "coreVersion": 131, 
    "type": "windows"
}

返回数据

{
    "code": 0,
    "msg": "Success",
    "requestId": "a5a2465555edad295e5342265c12b779",
    "timestamp": 1740726236985,
    "data": null
}

13.修改备注

• Path：/api/v1/container/batch-update-remark
• Method： POST
• Content-Type：application/json
• 接口描述：刷新指纹
• 仅支持v3.37以上版本，请前往官网下载客户端最新版本【下载Hubstudio最新版】

请求示例

{
    "containerCodes":[],
    "remark":"",
    "coreVersion": 131, 
    "type":0
}

返回数据

{
    "code": 0,
    "data":true,
    "message":"",
    "requestId":"",
    "success":true,
    "timestamp":0
}