Skip to content

Realtime

realtime_namespace_update

Update the policy of a realtime namespace

Tool

realtime_namespace_update

Update the policy of a realtime namespace

Update the policy of a realtime namespace

Behavior

HTTP
PATCH /realtime/namespaces/:name

Arguments

NameTypeRequiredDescription
namestringNamespace name to update
archivestringHistory archive policy: off, or durably retain archived entries for N days (requires history != "none")
historystringHistory retention policy for channels in this namespace
presencebooleanWhether presence is enabled on channels in this namespace
visibilitystringpublic: any authenticated identity may subscribe without a grant
clientEventsbooleanWhether clients may publish events directly
identifiedOnlybooleanWhether only identified (non-anonymous) identities get capabilities
subscribeProxyUrlstringIf set, token mint consults this URL per requested channel (fail-closed); null disables
encryptionRequiredbooleanWhether payloads must be end-to-end encrypted
historyWindowSecondsintegerRetention window in seconds; required when history is "window"

Response

FieldTypeAlwaysDescription
idstring
namestring
archivestringHistory archive policy
historystring
presenceboolean
createdAtstring
updatedAtstring
visibilitystring
clientEventsboolean
identifiedOnlyboolean
subscribeProxyUrlstring
encryptionRequiredboolean
historyWindowSecondsinteger
subscribeProxySecretstringFull proxy signing secret — returned ONLY when subscribeProxyUrl is set/changed
subscribeProxySecretPrefixstringVisible prefix of the proxy signing secret; null when no proxy url is set

Try it

Update the policy of a realtime namespace.

When to use

Update the policy of a realtime namespace

Example

Ask your agent something like this:

Update the policy of a realtime namespace.

The agent will invoke realtime_namespace_update with these arguments:

{
  "name": "<name>"
}

Esc

Start typing to search the docs.

navigateselect