Skip to content
Console
Menu

Getting Started

Authentication

KV Store

Put in Namespaces

Creates or replaces a namespace's rules.

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

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 PUT https://api.realtime.sylphx.com/v1/namespaces/name
  • Scope realtime:write
  • Effect write — a successful call changes state.
  • Collection namespaces
  • Host https://api.realtime.sylphx.com

#Request

FieldTypeWhat it is
namestringThe namespace name; see Namespace.name. Required.
historyHistoryPresetHow much history channels keep. One of none, short, standard.
presenceboolWhether channels track presence.
client_publishboolWhether clients may publish.

#Response

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 -X PUT "https://api.realtime.sylphx.com/v1/namespaces/name" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'