API 地址
默认 REST API 与管理控制台由控制面提供,API 前缀为 /api/v1。
BASE URLReplace the host
https://<your-server>:9080/api/v1当 API 通过 TLS 终止代理暴露时,请根据部署配置填写外部 HTTPS 主机名。
确认服务与数据库状态
健康检查端点位于 API 前缀之外,可用于本地验证或编排系统的服务探测。
HTTPHealth endpoint
curl -sf http://localhost:9080/healthz生产探测地址、访问协议和网络限制应符合你的监听配置。
使用受控的身份认证
控制面提供身份认证 API。对外部集成应通过文档支持的认证流程获取访问令牌,并遵循令牌过期与权限限制。
保护 API 凭据。不要将管理员密码、JWT 密钥或访问令牌写入公开仓库、静态网页、浏览器端代码或日志。对控制台和 API 端口应用网络访问限制。
接口资源概览
| 领域 | 主要用途 |
|---|---|
| 身份认证与用户 | 登录、账户和认证相关操作。 |
| 站点与代理配置 | 站点、路由、源站和站点级策略配置。 |
| 安全策略 | WAF、访问规则、IP 组与限流配置。 |
| Agent 与集群 | 注册信息、状态、心跳和节点操作。 |
| 事件与系统 | 请求日志、统计、健康与运行状态。 |
此表是概览,不承诺接口路径或资源字段的版本兼容。实际集成时以当前 release 的 API 文档和服务响应为准。
完整接口定义
仓库中的 API 参考包含方法、路径、请求参数、响应结构和示例。请同时记录部署版本,并在升级前检查接口变更。
打开完整 REST API 参考