Skip to content
Console
Menu

Getting Started

Authentication

KV Store

Namespaces

The `namespaces` collection of Sylphx Realtime.

The namespaces collection of Sylphx Realtime — served at https://api.realtime.sylphx.com.

Service Sylphx Realtime · served at https://api.realtime.sylphx.com

Not available yet. Sylphx Realtime is declared in the registry but no backend serves it: every call answers 501 with the problem code UNIMPLEMENTED.

#Methods

Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.

MethodCallWhat it does
PUTputCreates or replaces a namespace's rules. Existing channels follow the new rules from their next message; shortening history trims at the next publish.
GETgetReads a namespace.
GETlistLists the environment's namespaces.
DELETEdeleteDeletes a namespace, its channels' history and presence, and closes the subscriptions on them.

#put

Creates or replaces a namespace's rules. Existing channels follow the new rules from their next message; shortening history trims at the next publish.

PUT https://api.realtime.sylphx.com/v1/namespaces/name · scope realtime:write · effect write · not available yet · Request, response and examples

#get

Reads a namespace.

GET https://api.realtime.sylphx.com/v1/namespaces/name · scope realtime:read · effect read · not available yet · Request, response and examples

#list

Lists the environment's namespaces.

GET https://api.realtime.sylphx.com/v1/namespaces · scope realtime:read · effect read · not available yet · Request, response and examples

#delete

Deletes a namespace, its channels' history and presence, and closes the subscriptions on them.

DELETE https://api.realtime.sylphx.com/v1/namespaces/name · scope realtime:write · effect destructive · not available yet · Request, response and examples