Skip to content

Node Compute Engine ​

Stash Cloud orchestrates independent rgbldkd nodes. The public integration contract is V3 node management; developers do not need to operate infrastructure directly.

Lifecycle ​

  • Create: call POST /v3/nodes with an API Key. The body supports only optional name (or {}); success is 202. Node types and resource specification selectors are not supported.
  • Query: lists use pagination {nodes,next_cursor}; details include status, public_dns, api_base_url, optional existing p2p_*, failure information and resource fields. An assigned domain neither means readiness nor grants API Keys access to native interfaces.
  • Start/stop: POST /v3/nodes/{id}/start and /stop return 200 with node details.
  • P2P: POST /v3/nodes/{id}/p2p applies for a public address for a running user node. An HTTPS API address is not a P2P connection address.
  • Delete: DELETE /v3/nodes/{id} returns 200 with a deletion result. There is no public undo-delete or backup restore operation.
  • Supply a stable UUID for writes and reuse it when retrying the same operation. The key, X-Network and operation scope must match.

Creation is asynchronous. Production status polling should have an overall deadline, failure-state handling and backoff. Do not promise a fixed readiness time or default quota.

The diagram below shows the state flow of these operations under the current public contract. status is a server-returned string and is not exhaustively listed here; state or idempotency conflicts may return 409.

Runtime policy and capability boundaries ​

Idle reclamation and on-demand wake-up are service runtime policies, not roles chosen in creation requests. Do not assume every management request extends activity or that business requests always succeed while a node is stopped.

API Keys provide only public management capabilities, not native node operations. Keep-alive product features do not grant funds or trading authority.

Capacity targets, automatic snapshots and off-site retention are not public API capability promises; consult the service agreement.

Integration index ​

Quickstart, authentication, runtime scope, export and backups.

Trade and secure your RGB assets | Unlock the full potential of the RGB protocol