Stratum Peer REST Docs
Stratum Peer REST is the on-VM API for ledger operations against Hyperledger Fabric peers provisioned by Chain Deploy. It is not a public Cloud Run endpoint — callers reach it over the customer VPC (typically port 3000).
Adapters, dashboards, and partner services talk to the same contract: sync assets, run wallet token ops, and scrape health/metrics. The REST surface is the stable interoperability contract; chaincode upgrades stay behind it.
Who this is for
| You are… | The problem you feel | What Stratum gives you |
|---|---|---|
| Integrator wiring an adapter | Need a private, predictable HTTP surface on the peer | /api/assets, /api/tokens, /health on the VM |
| Platform operator | Need readiness vs liveness and SLIs | /health/ready, /health/live, Prometheus /metrics |
| Wallet / token client | Need issue, transfer, redeem without admin routes | Account-model wallet ops documented under Tokens |
This documentation set is Early Access (v0). It answers how do I call Peer REST? — not how Fabric endorsement or chaincode internals decide ledger state. See Disclosure Boundary.
Explore by topic
| Topic | Start here |
|---|---|
| Auth header and VPC model | Authentication |
| Error envelope | Errors |
| Wallet operations | Tokens |
| Sync / query | Assets |
| SLIs and health | Observability |
| Chaincode upgrade vs migration | Upgrade & compatibility |
| Machine-readable contract | API reference |
Network model
- Peer REST runs on the peer VM (Docker / host process on
:3000). - Primary access control is VPC-private — firewall rules restrict callers to internal ranges.
X-Api-Keyis an optional second factor whenAPI_KEYis configured on the peer.- There is no public internet base URL for this API. Use the peer’s internal IP or private DNS from within the VPC (or via a VPC connector from Cloud Functions / Cloud Run).
Reading order
| To answer | Read |
|---|---|
| How do I authenticate? | Authentication |
| What does an error look like? | Errors |
| How do wallet ops work? | Tokens |
| How do I sync assets? | Assets |
| What are the SLIs? | Observability |
| Will my client break on upgrade? | Upgrade & compatibility |
| Full OpenAPI | API reference |
Resources
Tokens
Account-model wallet operations on fungible-token chaincode.
Upgrade & compatibility
F1 chaincode upgrade vs deferred F2 Panurus — REST is the stable contract.
API reference
Browse the OpenAPI 3.1 contract for Peer REST public routes.
Disclosure Boundary
What is published for interoperability — and what stays private.
Live try-it is disabled on this portal — call Peer REST from your VPC with curl or your own client. Signed-in operators mint ingestion API keys and read operator auth docs under Dashboard → Account → Developer API docs.