REST API

Zorven REST API

通过编程方式管理隧道、客户端、域名和 IP 规则,并读取请求日志与用量数据。OpenAPI 3.1 参考见下方。

  1. 创建令牌打开控制台的 API 密钥页面。
  2. 选择权限范围和有效期选择所需的权限范围(例如 tunnels:read)和过期时间。令牌只会显示一次。
  3. 发送请求在每个请求的 Authorization: Bearer 请求头中带上令牌。
$curl -H "Authorization: Bearer zrv_api_..." https://zorven.app/api/v1/tunnels

MCP 与 OAuth 2.1:同一套 API 也可通过 https://zorven.app/mcp 访问(OAuth 2.1 + PKCE S256,支持动态客户端注册)。OAuth 的 full 权限范围让 MCP 客户端拥有与你的控制台会话相同的权限(绝不超出你本人的权限)。它在授权确认页面默认关闭,并且需要在 5 分钟内重新登录(step-up);完全访问令牌有效期为 30 分钟(其他访问令牌为 1 小时),每次调用都会写入审计日志,API 令牌和服务账号等少数端点仍被排除在外。请参阅下方参考文档中的“OAuth 2.1 和 MCP”。

API 访问适用于 Pro 及以上套餐。每个租户的程序化请求限制为约 30 次/秒。对比套餐,或查看 CLI 文档。