文档菜单

入门

代理基础

代理API

响应缓存

Litport API

MCP服务器

套餐API

读取您的不限流量代理套餐，并管理每个套餐的IP白名单。写入需要Bearer API密钥；已登录的文档会话可以读取但不能写入。每次写入都是一次调用：没有前置条件请求头，最后一次成功的写入生效。

列表与读取#

GET /api/v1/packages
GET /api/v1/packages/{packageId}
Authorization: Bearer lit_...
参数 规则
limit 1到100的整数；默认为50。
cursor 上一页的page.nextCursor，原样传回。 
{
  "data": {
    "id": 45,
    "status": "active",
    "product": { "key": "dc-shared-rotating", "name": "DC Shared Rotating" },
    "country": "us",
    "quantity": 2,
    "addOns": ["high-speed"],
    "limits": { "speedMbps": 20, "connections": 300, "requestsPerSec": 25 },
    "renewsAt": "2027-01-01T00:00:00.000Z",
    "endsAt": null,
    "tokenIds": [12345, 12346]
  }
}

未知、不属于您或无法解析的packageId会返回404 PACKAGE_NOT_FOUND。

状态#

status 含义 日期
awaiting-payment 已下单，尚未付款。 两者均为null。
active 正在付费，包括已安排结束的周期。 renewsAt为下次续费时间；如果不会续费，endsAt为停止时间。
suspended 付款失败或套餐已被暂停。 已知时为endsAt，否则为null。
ended 不再有效。 endsAt为结束时间。
setup-failed 开通未完成。 两者均为null。

product.key是目录中的产品系列键，product.name是其显示名称。addOns列出公开的附加项名称：high-speed、more-allowed-ips、multi-location。limits是此套餐配置下每个令牌的有效速度、连接数和请求速率上限，无法确定时为null。tokenIds列出套餐当前的令牌；用令牌读取每一个。

IP白名单#

套餐的IP白名单使其可以接受来自确切公网IPv4源地址的免密码连接。它适用于套餐中每个就绪的代理端点；这些令牌各自也会将自己的免密码端点报告为ipAuth（见令牌）。无论列表是否为空，凭证都继续有效。不支持IPv6；联系客服。

GET /api/v1/packages/{packageId}/allowed-ips
Authorization: Bearer lit_...

{
  "data": {
    "packageId": 45,
    "limit": 50,
    "ips": ["8.8.8.8", "9.9.9.9"],
    "available": true,
    "unavailableCode": null
  }
}

limit在没有该附加项的套餐中为1，有more-allowed-ips时为50。available: false表示IP白名单功能本身目前不可用；此时unavailableCode会说明原因。

更改列表#

一次设置整个列表：

PUT /api/v1/packages/{packageId}/allowed-ips
Authorization: Bearer lit_...
Content-Type: application/json

{"ips": ["8.8.8.8", "9.9.9.9"]}

全部成功或全部失败：只要有一个IP无效，整个请求就会被拒绝，返回400 INVALID_IP并指出该IP；列表超过limit则返回409 ALLOWED_IPS_LIMIT_REACHED。发送{"ips": []}可清空列表。

添加或移除单个IP，无需先读取列表：

PUT /api/v1/packages/{packageId}/allowed-ips/{ip}
DELETE /api/v1/packages/{packageId}/allowed-ips/{ip}
Authorization: Bearer lit_...

两者都不带请求体。添加列表中已有的IP，或移除已不存在的IP，都是成功的空操作。移除只会将该行标记为已撤销，因此审计历史得以保留；它不会再出现在ips中。

每次IP白名单写入都返回上文所示的同一个{data: ...}结构。

安全与限制#

添加IP会授予该来源对套餐中每个就绪端点的免密码访问权限；移除IP则收回访问权限。对同一套餐的写入限制为每60秒20次，这是在每个密钥的限制之外额外增加的；见速率限制。

IP白名单错误#

状态码 错误码 含义
400 INVALID_IP 该地址不是确切的公网IPv4字面量。消息中会指出该地址。
400 IPV6_UNSUPPORTED 发送了IPv6地址。联系客服。
400 INVALID_REQUEST_BODY 设置列表的请求体不是严格的{"ips": [...]}。
404 PACKAGE_NOT_FOUND packageId未知、不属于您或格式错误。
409 ALLOWED_IPS_LIMIT_REACHED 列表将超过limit。联系客服以提高上限。
409 PACKAGE_INACTIVE 套餐未在使用中。移除IP仍然有效。
409 CONCURRENT_CHANGE 同一时刻对该套餐进行了另一次写入。重试同一请求。
429 RATE_LIMITED 超过每个密钥或每个套餐的限制。等待Retry-After。
503 ALLOWED_IPS_UNAVAILABLE IP白名单存储或端口分配暂时不可用。在Retry-After之后重试。

每个错误码都在API错误中有说明；schema见OpenAPI规范。

多地点代理#

“多地点”代理的目标城市和运营商是令牌级设置，而不是套餐级设置：用令牌：位置读取和更改。

MarkdownOpenAPI