Local API V2 – Cookie接口

说明：

• Cookie 接口支持普通 Cookie 读写场景。启用受保护 Cookie 加密的环境不支持通过 Local API 查询、导入或清空 Cookie。
• 查询返回的 Cookie 使用标准 value 字段；导入 Cookie 时也请传入 value 字段。

查询环境 Cookie

接口地址

GET /openapi/v2/profiles/{profileId}/cookies

用于查询环境 Cookie。

路径参数

名称	类型	必填	说明
profileId	string	是	环境 ID。

查询参数

名称	类型	必填	说明
domain	string	否	按 Cookie 域名过滤。不传表示返回全部域名。

响应参数

data 为 Cookie 查询结果：

名称	类型	说明
profile_id	string	环境 ID。
cookies	object[]	Cookie 列表，字段见 Cookie 参数。
cookie_convert_state	boolean	Cookie 是否转换成功。
cookie_encrypt_status	string	Cookie 加密状态：OLD_ENCRYPT、NEW_ENCRYPT。

覆盖导入环境 Cookie

接口地址

PUT /openapi/v2/profiles/{profileId}/cookies

覆盖导入 Cookie，会用请求体内容替换当前环境 Cookie。

路径参数

名称	类型	必填	说明
profileId	string	是	环境 ID。

请求参数

请求体使用 Cookie 导入参数，见 Cookie 参数。

增量导入环境 Cookie

接口地址

POST /openapi/v2/profiles/{profileId}/cookies

增量导入 Cookie，会在当前环境 Cookie 基础上合并写入请求体内容。

路径参数

名称	类型	必填	说明
profileId	string	是	环境 ID。

请求参数

请求体使用 Cookie 导入参数，见 Cookie 参数。

请求示例

  -d '{
    "mode": "merge",
    "cookies": [
      {
        "domain": ".example.com",
        "path": "/",
        "name": "session",
        "value": "cookie-value",
        "expiration_date": 1893456000,
        "http_only": true,
        "secure": true,
        "same_site": "lax"
      }
    ]
  }'

清空环境 Cookie

接口地址

DELETE /openapi/v2/profiles/{profileId}/cookies

用于清空环境 Cookie。

路径参数

名称	类型	必填	说明
profileId	string	是	环境 ID。

参数说明

Cookie 参数

CookieImportRequest：

名称	类型	必填	说明
mode	string	否	导入模式。可选值：replace、merge。
cookies	object[]	否	Cookie 列表。单次最多 5000 个；导入时每项的 domain、name、value 必填。

CookieItem：

名称	类型	必填	说明
domain	string	导入时是	域名。
path	string	否	路径。
name	string	导入时是	Cookie 名称。
value	string	导入时是	Cookie 值，可为空字符串但不能为 null。
encrypted_value	string	否	Cookie 加密存储值，仅用于读取响应；导入时请使用 value。
expiration_date	integer	否	过期时间，Unix 时间戳秒。
http_only	boolean	否	是否 HttpOnly。
secure	boolean	否	是否 Secure。
same_site	string	否	SameSite 策略。可选值：unspecified、no_restriction、strict、lax。
host_only	boolean	否	是否 HostOnly，兼容扩展 Cookie 格式。
session	boolean	否	是否会话 Cookie，兼容扩展 Cookie 格式。
store_id	string	否	Cookie Store ID，兼容扩展 Cookie 格式。
has_expires	boolean	否	是否显式设置过期时间，兼容扩展 Cookie 格式。
priority	string	否	优先级，兼容扩展 Cookie 格式。
is_same_party	boolean	否	是否 SameParty。