API 参考
公开文档页只给接口目录和用途。要看当前实例的请求体示例、TTL 示例和域名示例，去控制台内 /api-keys/docs。
Metadata 与 Domains
| 接口 |
用途 |
GET /api/meta |
读取 active 域名、TTL、地址规则与 Passkey 能力 |
GET /api/domains/catalog |
读取 Cloudflare 可见 zone + 项目状态 |
GET /api/domains |
读取项目内已有域记录 |
POST /api/domains/bind |
创建 apex Cloudflare full zone 并接入项目；子域会返回推荐的 apex/subdomain 指引 |
POST /api/domains |
启用一个 catalog 域 |
POST /api/domains/:id/catch-all/enable |
开启项目侧 Catch All，并接管 Cloudflare catch-all 到邮件 Worker |
POST /api/domains/:id/catch-all/disable |
关闭项目侧 Catch All，并恢复开启前的 Cloudflare catch-all 配置 |
POST /api/domains/:id/retry |
重试接入失败的域 |
POST /api/domains/:id/disable |
停用一个项目域 |
POST /api/domains/:id/delete |
删除项目直绑的 Cloudflare zone，并软删除本地记录 |
Auth 与 API Keys
| 接口 |
用途 |
POST /api/auth/passkey/options |
生成浏览器 passkey 登录 challenge |
POST /api/auth/passkey/verify |
校验 passkey 登录并签发会话 |
GET /api/auth/session |
读取当前登录会话 |
POST /api/auth/session |
用 API Key 换会话 |
DELETE /api/auth/session |
退出登录 |
GET /api/passkeys |
列出当前用户的 passkeys |
POST /api/passkeys/registration/options |
生成 passkey 注册 challenge |
POST /api/passkeys/registration/verify |
保存校验通过的 passkey |
DELETE /api/passkeys/:id |
撤销 passkey |
GET /api/api-keys |
列出 API Keys |
POST /api/api-keys |
创建 API Key |
POST /api/api-keys/:id/revoke |
撤销 API Key |
Mailboxes
邮箱记录由 mailboxSchema 定义；当前特别关注这些元数据字段：
source: registered | catch_allroutingRuleId: 预注册邮箱通常有值；Catch All 自动物化邮箱固定为 nullcreatedVia: web | api_key | system | unknowncreatedByApiKey: 当邮箱由 Bearer API key 创建时返回 { id, name, prefix }，否则为 nulltags: 规范化后的小写 tag；GET /api/mailboxes 可重复传 tag，只返回包含全部 tag 的邮箱
| 接口 |
用途 |
GET /api/mailboxes |
列出邮箱 |
POST /api/mailboxes |
创建邮箱 |
POST /api/mailboxes/ensure |
幂等确保邮箱存在 |
GET /api/mailboxes/resolve |
按地址解析邮箱 |
GET /api/mailboxes/:id |
读取单个邮箱 |
PATCH /api/mailboxes/:id/tags |
替换邮箱 tags |
DELETE /api/mailboxes/:id |
删除邮箱 |
Messages
当某个域名已开启 Catch All 时，未知地址的来信会先在运行时自动物化出
source=catch_all 的长期邮箱，然后继续进入现有的消息持久化链路。
| 接口 |
用途 |
GET /api/messages |
列出消息 |
GET /api/messages/:id |
读取结构化消息详情 |
GET /api/messages/:id/raw |
下载原始 .eml |
GET /api/messages 支持重复的 mailbox、mailboxId 与 mailboxStatus
查询参数。回收站/历史聚合应使用 mailboxStatus=expired，不要把每个过期邮箱
ID 都拼进 URL。
Users
| 接口 |
用途 |
GET /api/users |
列出用户 |
POST /api/users |
创建用户 |