一套 API。一个页面。不绑定任何 SDK。

server 是我们虚拟机管理程序池中的一台虚拟机，或是独立服务器产品线中的一个物理节点。本页上的其他资源，要么描述服务器，要么挂接到服务器上，要么由服务器产生事件。

对象

端点

• GET /servers 列出你的服务器。
• POST /servers 创建新服务器。
• GET /servers/{id} 获取单个服务器。
• PATCH /servers/{id} 更新 name、tags 或 labels。
• DELETE /servers/{id} 销毁服务器。此操作不可逆。
• POST /servers/{id}/reboot 重启。添加 ?hard=true 可跳过 ACPI。
• POST /servers/{id}/rebuild 重新安装操作系统镜像。磁盘数据将被销毁。
• POST /servers/{id}/rescue 引导进入救援 ISO。
• POST /servers/{id}/stop 正常停止（ACPI 关机）。
• POST /servers/{id}/start 启动已停止的服务器。
• GET /servers/{id}/console 一次性签名的 noVNC URL（有效期 5 分钟）。
• GET /servers/{id}/metrics 30 天的 CPU / RAM / 磁盘 / 带宽汇总数据。
• POST /servers/{id}/rdns 为 IPv4 和/或 IPv6 设置反向 DNS。

image 是服务器启动所用的磁盘模板。官方镜像由我们维护；自定义镜像则是你上传的 ISO。

对象

端点

• GET /images 列出镜像（可按 family、arch、type 筛选）。
• GET /images/{id} 获取单个镜像。
• POST /images 上传自定义 ISO。使用 multipart/form-data，最大 4 GiB。
• DELETE /images/{id} 删除自定义镜像（对官方镜像无效）。

plan 描述一种可购买的硬件规格。价格以 USD 为参考；每台服务器在部署时从你的余额中一次性预付整个周期的费用，周期可选 1、3、6 或 12 个月（折扣分别为 0%、25%、35% 和 50%）。充值的币种金额按生成账单时的即时汇率折算。

对象

端点

• GET /plans 列出套餐。
• GET /plans/{id} 获取套餐。

region 是我们四个 PoP（接入点）之一。每个 PoP 由独立的法律实体运营，并独立路由。

对象

端点

• GET /regions 列出地区。
• GET /regions/{id} 获取地区。

安装时注入服务器 authorized_keys 的公钥。私钥部分始终留在你的设备上，我们永远看不到。

对象

端点

• GET /ssh-keys 列出 SSH 密钥。
• POST /ssh-keys 添加新的 SSH 密钥。
• GET /ssh-keys/{id} 获取密钥。
• DELETE /ssh-keys/{id} 删除密钥。不影响已部署的服务器。

用于对该 API 进行身份验证的长期有效密钥。明文令牌仅在创建时返回一次；服务端只保存其 SHA-256 摘要。

对象

端点

• GET /account/tokens 列出令牌。
• POST /account/tokens 创建令牌（明文仅返回一次）。
• DELETE /account/tokens/{id} 立即吊销令牌。

以读取为主的端点，涵盖你当前的余额、交易历史以及充值流程。

balance 对象

端点

• GET /billing/balance 当前余额 + runway。
• GET /billing/ledger 分页的交易历史（扣费、充值、入账）。
• POST /billing/topup 为指定币种生成一次性充值地址。
• GET /billing/topup/{id} 轮询充值单状态（pending / confirming / credited / expired）。

可挂载到同一地区服务器上的持久化块存储。存储卷在服务器被销毁后依然保留。

对象

端点

• GET /volumes 列出存储卷。
• POST /volumes 创建存储卷。
• GET /volumes/{id} 获取。
• PATCH /volumes/{id} 调整容量（只能增大 size_gb）或重命名。
• DELETE /volumes/{id} 销毁。必须先卸载。
• POST /volumes/{id}/attach 挂载到服务器（请求体：{"server":"srv_…"}）。
• POST /volumes/{id}/detach 卸载。

服务器根磁盘在某一时间点的副本。快照经过去重，并加密存储。快照无法导出——它们的作用是让你能从已知良好的状态重建服务器。

对象

端点

• GET /snapshots 列出快照。
• POST /servers/{id}/snapshots 为服务器创建快照。
• GET /snapshots/{id} 获取。
• POST /servers/{id}/restore 从快照恢复服务器（基于 snap_… 重建）。
• DELETE /snapshots/{id} 删除快照。

有状态、默认丢弃的包过滤器，在虚拟机管理程序层面执行——位于客户机之外。一个组是一组具名规则；每条规则允许匹配某个五元组的入站或出站流量。

对象

规则对象

端点

• GET /firewall/groups 列出防火墙组。
• POST /firewall/groups 创建组。
• GET /firewall/groups/{id} 获取。
• PATCH /firewall/groups/{id} 更新 name、default_action、applied_to。
• DELETE /firewall/groups/{id} 删除组（该组不能处于已应用状态）。
• POST /firewall/groups/{id}/rules 追加一条规则。
• PUT /firewall/groups/{id}/rules 替换规则列表（原子操作）。
• DELETE /firewall/groups/{id}/rules/{rule_id} 删除单条规则。

为你账户的事件订阅一个 URL。每当发生值得关注的事情，我们会向你的端点 POST 一个 JSON 事件，并附上可供你验证的 HMAC-SHA256 签名。

对象

端点

• GET /webhooks 列出订阅。
• POST /webhooks 创建。响应中包含 secret（明文，仅此一次）。
• GET /webhooks/{id} 获取。
• PATCH /webhooks/{id} 更新 url、events、active。
• DELETE /webhooks/{id} 取消订阅。
• POST /webhooks/{id}/test 发送一个合成的 ping 事件。
• GET /webhooks/{id}/deliveries 最近 7 天的投递尝试记录。

针对你账户发出的每一个经过身份验证、会改变状态的请求，并记录发起者。保留 90 天。

对象

端点

• GET /audit/events 列出审计事件。可按 action、resource、from、to 筛选。
• GET /audit/events/{id} 获取单个事件。