对外 API 接口文档

localhost.cc 提供对外 API,你可以用程序化方式管理自己的子域名和 DNS 解析记录。

认证

所有接口都在 /api/v1/open 路径下,请求时需在 HTTP 头携带 API Key:

Authorization: Bearer <你的 API Key>

API Key 在 账号设置 → API 页面创建。Key 只在创建时完整显示一次,请立即复制保存。

接口列表

• GET /api/v1/open/subdomains — 列出我的全部子域名
• GET /api/v1/open/subdomains/{id} — 查看单个子域名
• GET /api/v1/open/subdomains/{id}/records — 列出某子域名的 DNS 记录
• POST /api/v1/open/subdomains/{id}/records — 新增一条 DNS 记录
• PUT /api/v1/open/subdomains/{id}/records/{recordId} — 修改一条 DNS 记录
• DELETE /api/v1/open/subdomains/{id}/records/{recordId} — 删除一条 DNS 记录

DNS 记录支持的类型:A / AAAA / CNAME / TXT。

示例

列出我的子域名:

curl https://localhost.cc/api/v1/open/subdomains \
  -H "Authorization: Bearer lc_xxx"

列出某子域名的 DNS 记录:

curl https://localhost.cc/api/v1/open/subdomains/1/records \
  -H "Authorization: Bearer lc_xxx"

新增一条 A 记录:

curl -X POST https://localhost.cc/api/v1/open/subdomains/1/records \
  -H "Authorization: Bearer lc_xxx" \
  -H "Content-Type: application/json" \
  -d '{"type":"A","content":"1.2.3.4"}'

说明

• 所有接口只能操作 你自己 名下的子域名。
• API Key 一旦泄露,请立即在账号设置页删除并重新创建。
• 处于「违规冻结」或「待删除」状态的子域名无法通过 API 修改。