管理 API
OxiDNS 的管理 API 是独立控制平面，提供健康检查、配置校验与保存、进程控制、日志、升级、插件扩展 API 和 Prometheus 指标。本页是接口地图；请求格式、返回字段和示例分别位于专题页。
使用顺序
- 按访问约定与安全配置监听、TLS、Basic Auth、CORS 和 WebUI。
- 用
GET /api/healthz检查监听，再用GET /api/readyz判断 DNS 服务是否就绪。 - 修改配置前调用校验接口；保存后通过 reload 接口应用，并轮询 reload 状态。
- 只向可信网络暴露控制、日志、升级和插件数据接口。
- 将
/api/metrics接入 Prometheus 时，保持与管理面相同的访问控制边界。
接口地图
| 主题 | 主要路由 |
|---|---|
| 访问约定与安全 | 监听、HTTPS/mTLS、Basic Auth、WebUI、CORS、路由布局、配置模板 |
| 健康、控制、日志与升级 | /api/health*、/api/build、/api/control、reload、日志/SSE、upgrade |
| 配置接口 | 读取、写入、检查和校验配置 |
| 插件扩展 API | cache、matcher、provider、reverse lookup、query recorder |
| Prometheus 指标 | /api/metrics 与指标目录 |
兼容性说明
管理 API 属于当前二进制的控制面能力。部署自动化应先读取 /api/build 确认 bundle 和插件能力，并容忍可选插件路由不存在。升级前后请重新执行 readiness、配置校验和关键 API 冒烟测试。