Hubfly spaceDocs
Console

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

SurfaceBase URLCredentialUse
Dashboard APIhttps://api.hubfly.space/api/v1Dashboard bearer tokenServers, apps, keys, bindings, webhooks, inspection and operator actions.
WebSocketwss://<slug>.rt.hubfly.appApp key (public); channel authorization signed by your serverBrowser and mobile clients: subscribe, presence, client events.
Server APIhttps://<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

A key's secret is returned when the key is created and later only through an explicit reveal. Keep it on your servers; browsers only need the app key.

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.

Something unclear or out of date? Emailsupport@hubfly.spaceBack to top