Skip to content

HTTP API reference

Routes served by control (internal/api). Auth: none (public), org (Cognito/dev OIDC bearer), relay-secret / billing-secret (service-to-service shared secret). A suspended network gets 402 Payment Required on the billable routes.

methodpathauthsummary
GET/healthznoneliveness probe
POST/svc/relay/usagerelay-secretrelay egress report (idempotent on relay_id+session_id+sequence)
POST/svc/entitlementbilling-secretset a network’s plan/entitlement (billing webhook)
POST/svc/stripe/webhookstripe-signatureStripe subscription webhook → entitlement (cancel→suspend, reactivate→active)
POST/api/networksorgcreate a private network
GET/api/networksorglist the caller org’s networks
POST/api/enrollorgenroll a node (device proof-of-possession optional); 402 if suspended
GET/api/nodesorglist nodes (?network_id=)
DELETE/api/nodes/{id}orgdelete a node (revoke membership)
POST/api/nodes/{id}/heartbeatorgnode liveness + reachability candidates
POST/api/nodes/{id}/servicesorgattach a private service (mcp/a2a/llm/…)
GET/api/netmap/{id}orgsigned network map (peers + entitlement envelope)
GET/api/control-keyorgEd25519 netmap verify key (+ key_id)
GET/api/relay/{id}orgrelay endpoint + signed admission ticket; 402 if suspended
POST/api/capabilitiesorgissue a macaroon-style capability token
POST/api/gateway/resolveorgresolve a service via a capability; 402 if suspended
GET/api/usageorgmetering readout (totals + events)