Documentation
Realtime Channel API — v1
Overview
The realtime channel is a WebSocket endpoint used by the console to stream build and deployment events. Each project owns a single channel identifier; connections outside that identifier are rejected by the edge.
Handshake
Open a standard WebSocket connection to the project channel:
wss://<your-host>/rt/<channel>
The endpoint speaks binary frames only. On success the edge returns 101 Switching Protocols; a channel you do not own is indistinguishable from any other path on this host.
Status API
Public, unauthenticated, refreshed every 30 seconds:
GET /api/status
| Field | Type | Description |
|---|---|---|
| page.updated_at | string | ISO-8601 timestamp of the snapshot |
| status.indicator | string | none, minor, major |
| components | array | Per-service health and 60-day uptime |
Limits
- 128 concurrent channels per source address (configurable)
- 25 second handshake deadline
- TCP payloads only; datagrams are not forwarded
- Loopback, private and link-local destinations are blocked