API · Realtime
Realtime API
Manage realtime servers with Dashboard endpoints. Connect clients and publish from your servers with the Pusher-compatible protocol.
Choose an API
| Surface | Base URL | Credential | Use |
|---|---|---|---|
| Dashboard API | https://api.hubfly.space/api/v1 | Dashboard bearer token | Servers, apps, keys, bindings, webhooks, inspection and operator actions. |
| WebSocket | wss://<slug>.rt.hubfly.app | App key (public); channel authorization signed by your server | Browser and mobile clients: subscribe, presence, client events. |
| Server API | https://<slug>.rt.hubfly.app/apps/{app_id} | App key and secret (Pusher request signing) | Publish events, query channels, Hubfly space extensions from your backend. |
Endpoint groups
These groups cover 59 Dashboard endpoints. Server lifecycle, network, operations, logs, metrics, alerts and audit use the managed instance routes shared with Managed Databases; realtime routes live under /projects/:projectId/managed/instances/:instanceId/realtime.
Asynchronous operations
Create, start, stop, restart, resize, upgrade and delete return an operationId. Poll GET /api/v1/projects/:projectId/managed/instances/:instanceId/operations/:operationId until it ends. Create uses the same price quote (quotedHourlyTotal) and idempotencyKey rules as databases. A restart hands connections over to the new process in place, and a resize applies live without a restart. An upgrade stops the server for about 10–20 seconds; clients reconnect on their own.
Key secrets
Permissions and credentials
Each endpoint lists the permission it needs: realtime:read, realtime:publish or realtime:admin. A scoped token must hold the exact permission the route requires. Calling a realtime route on a database instance returns 409 MANAGED_FEATURE_UNSUPPORTED. See authentication and errors.