Skip to content

设备侧 API

树莓派或硬件 agent 使用的设备心跳和 ACME DNS-01 自动证书接口。

基础信息

  • 基础路径/device
  • 认证方式:设备 Token 或设备侧签名凭据;用户侧操作见用户设备 API。

端点

补充端点

本节补充 plans/need-update-api.md 中尚未覆盖到 docs-site 的接口。端点标题保持严格的 METHOD /path 格式,便于后台文档覆盖率服务识别。

POST /device/acme/dns-01

ACME DNS-01 challenge 写 TXT

认证:设备 Token 或设备侧签名凭据;用户侧操作见用户设备 API。 请求:请求体为 JSON,包含创建、提交、安装、发布或业务动作所需字段。

响应:成功时返回创建或更新后的资源对象,或 { "success": true }

常见错误400 参数非法,401 未认证,403 权限不足,404 资源不存在;服务端或上游异常返回 500


DELETE /device/acme/dns-01

ACME DNS-01 challenge 删除 TXT

认证:设备 Token 或设备侧签名凭据;用户侧操作见用户设备 API。 请求:通常无请求体;删除类接口通过路径参数定位资源,部分接口会执行软删除、释放绑定或撤回流程。

响应:成功时返回 { "success": true } 或等价删除结果;资源不存在、无权限或存在依赖时返回 4xx。

常见错误400 参数非法,401 未认证,403 权限不足,404 资源不存在;服务端或上游异常返回 500


POST /device/heartbeat

设备心跳上报 LAN IP(驱动 DNSPod A 记录同步)

认证:设备 Token 或设备侧签名凭据;用户侧操作见用户设备 API。 请求:请求体为 JSON,包含创建、提交、安装、发布或业务动作所需字段。

响应:成功时返回创建或更新后的资源对象,或 { "success": true }

常见错误400 参数非法,401 未认证,403 权限不足,404 资源不存在;服务端或上游异常返回 500

AI Workflow Editor