APIs
HTTP APIs exposed by the engine and the hosted platform.
rstream exposes API surfaces in two places. The engine exposes a small HTTP API used for inspection, listing resources, and signaling. The hosted platform exposes control plane APIs used to manage projects, credentials, and tokens.
This page focuses on the engine API surface because it is directly relevant to tunnel operations and works in both hosted and self-hosted deployments. Control plane APIs are documented separately.
Engine HTTP API
The engine registers the following HTTP endpoints under /api:
/api/clients/api/tunnels/api/websocket
The engine HTTP API accepts only GET requests for these endpoints. Authentication tokens are read from Authorization: Bearer <token> and, when the header is not present, from the rstream.token query parameter.
/api/clients and /api/tunnels return JSON lists scoped to the authenticated principal. /api/websocket upgrades the connection and streams events.