Skip to content
Console
Menu

Getting Started

Authentication

KV Store

List in Namespaces

Lists the environment's namespaces.

Lists the environment's namespaces.

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

  • Path GET https://api.realtime.sylphx.com/v1/namespaces
  • Scope realtime:read
  • Effect read — nothing is written.
  • Collection namespaces
  • Query page_size, page_token
  • Host https://api.realtime.sylphx.com

#Request

FieldTypeWhat it is
page_sizeint32At most this many namespaces; the service caps it.
page_tokenstringThe next_page_token of the previous page.

#Response

FieldTypeWhat it is
namespacesNamespace[]The page of namespaces.
next_page_tokenstringEmpty on the last page.

#Namespace

FieldTypeWhat it is
namestringThe namespace name: 1 to 32 characters of a-z, 0-9, - and _, starting with a letter. It is the part of a channel before the first colon, and never changes. Required.
historyHistoryPresetHow much history channels keep. Default NONE. One of none, short, standard.
presenceboolWhether channels track who is present. Default off.
client_publishboolWhether a client holding a token with the publish capability may publish. Default off: only servers publish.
create_timetimestampWhen the namespace was created. Output only.
update_timetimestampWhen the rules last changed. Output only.

#Errors

Every error arrives in the body Errors describes.

#Examples

curl "https://api.realtime.sylphx.com/v1/namespaces" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"