Integration · REST API

通过 API,管理你的 WAFred 实例。

控制面 API 面向站点、策略和运行状态集成。具体资源字段随项目版本更新;本页提供入口与安全使用提示,完整接口说明维护在代码仓库中。

Base URL

API 地址

默认 REST API 与管理控制台由控制面提供,API 前缀为 /api/v1。

自动化客户端通过 REST API 管理 WAFred Server,Server 再与 Agent 同步策略和遥测。
REST 管理接口与站点代理请求属于不同链路。
BASE URLReplace the host
https://<your-server>:9080/api/v1

当 API 通过 TLS 终止代理暴露时,请根据部署配置填写外部 HTTPS 主机名。

Health

确认服务与数据库状态

健康检查端点位于 API 前缀之外,可用于本地验证或编排系统的服务探测。

HTTPHealth endpoint
curl -sf http://localhost:9080/healthz

生产探测地址、访问协议和网络限制应符合你的监听配置。

Authentication

使用受控的身份认证

控制面提供身份认证 API。对外部集成应通过文档支持的认证流程获取访问令牌,并遵循令牌过期与权限限制。

保护 API 凭据。不要将管理员密码、JWT 密钥或访问令牌写入公开仓库、静态网页、浏览器端代码或日志。对控制台和 API 端口应用网络访问限制。

Resource groups

接口资源概览

领域主要用途
身份认证与用户登录、账户和认证相关操作。
站点与代理配置站点、路由、源站和站点级策略配置。
安全策略WAF、访问规则、IP 组与限流配置。
Agent 与集群注册信息、状态、心跳和节点操作。
事件与系统请求日志、统计、健康与运行状态。

此表是概览,不承诺接口路径或资源字段的版本兼容。实际集成时以当前 release 的 API 文档和服务响应为准。

Versioned reference

完整接口定义

仓库中的 API 参考包含方法、路径、请求参数、响应结构和示例。请同时记录部署版本,并在升级前检查接口变更。

打开完整 REST API 参考