API 概览

Stash Cloud API 让应用通过标准 HTTP 接口管理专属 RGB 闪电网络节点的完整生命周期——创建、查询、启动、停止、销毁与导出节点数据，无需自建服务器。使用钱包登录即可获取 API Key，无需申请账号。

节点运行由 RGB 闪电网络节点（rgbldkd，由 Bitlight Labs 开发）驱动。每个节点拥有专属域名，运行时接口直接在该域名访问。

职责边界

Stash Cloud 文档覆盖的接口分为两个清晰分离、互不重叠的层级：

层级	提供方	职责	文档
节点管理 API	Stash Cloud	节点的创建、查询、启动、停止、销毁；生命周期与配额；多租户隔离	本文档（鉴权、节点管理）
节点运行时 API	RGB 闪电网络节点	开通道、收发支付、RGB 资产操作等节点内能力	RGB 闪电网络节点 API，接口格式以 rgb-ldk-api-public 的 OpenAPI 规范为准

创建节点后，使用管理 API 返回的专属域名（public_dns / api_base_url）访问运行时 API。运行时接口使用节点自身的凭证，管理 API Key 不是运行时凭证，不能用于调用节点原生接口；访问授权与边界见运行时 API。

核心设计

确定性配额模型：每个租户有节点数硬上限，配额按网络分别生效；公开的创建接口不接受资源规格选择，具体配额以服务约定为准。
租户隔离：每个租户的节点与资源相互物理隔离；即使在内网，也无法跨租户操作。
单实例单网络：每个 API 端点绑定单一网络（regtest / testnet / mainnet）；网络通过请求头 X-Network 指定，请求体不携带网络字段，避免跨环境误操作。
差异化节点角色：平台按 user（默认）、hub 等角色区分节点的生命周期策略；公开 API 不提供角色选择器。
专属域名：每个节点拥有独立域名，运行时 API 直接在该域名访问。

节点类型与生命周期

节点在平台侧按角色区分，不同角色的资源回收与保活策略不同。公开的管理 API 不提供角色选择器，创建时只接受可选 name：

角色	说明	生命周期与存储
用户节点	默认角色，由钱包注册产生	空闲超过部署配置的时限后自动回收计算资源；存储持久化并有平台备份。回收后按部署策略在后续访问时唤醒，不应假设任意请求都会唤醒节点或延长活跃期限
Hub 节点	平台级节点，通常需联系 Stash Labs 开通	常驻运行，并向公共 Hub 目录与 P2P 对等发布（见 `GET /v3/public/hubs`、`GET /v3/public/peers/{ln_pubkey}`）

空闲回收、按需唤醒与备份保留属于部署策略，不是创建请求中的参数，也不作为公开 API 的能力承诺。LSP 保活保护是独立的产品能力，见 LSP。

接入方式

使用钱包登录官方控制台即可获取 API Key，无需申请账号。官方 Stash Wallet 与第三方应用/自建客户端使用同一套底层节点能力：

官方产品（Stash Wallet、RGB Dex 等）：通过钱包会话与节点访问授权访问节点，并使用官方产品的导出、保活等能力。
第三方开发者：通过官方控制台创建 API Key，使用本文档的公开管理 API（/v3）在自身租户内管理节点。

两套路径共享同一套节点基础设施，但凭证、权限与可调用接口互相独立，不能混用。

架构

钱包登录 / 应用
    │
    ▼
Stash Cloud API
    ├── 鉴权 + 配额检查
    └── 节点生命周期管理
            │
            ▼
    RGB 闪电网络节点（专属域名）
            │
            ▼
    节点运行时 API（开通道、收发、RGB 资产…）

文档导航

快速开始 — 用 API Key 完成一次完整的节点管理流程。
鉴权 — 权限范围、网络选择、安全存储、请求 UUID 与错误处理。
节点管理 — 创建、分页查询、启停、删除与 P2P 地址申请。
LSP — LSP 保活保护能力与边界。
节点数据导出 — 节点归档导出、保留与恢复边界。
运行时 API — 在专属域名访问节点原生接口的边界与方式。

进一步阅读

节点计算引擎 — 节点生命周期、异步创建与运行策略。
存储备份 — 导出、自行保管与恢复能力边界。
安全与访问 — API Key 安全、节点隔离与资金安全。
RGB 闪电网络节点 API — 节点运行时接口分组索引，完整规范见 rgb-ldk-api-public。

API 概览 ​

职责边界 ​

核心设计 ​

节点类型与生命周期 ​

接入方式 ​

架构 ​

文档导航 ​

进一步阅读 ​