Skip to content

Realtime

realtime_namespace_get

Get a realtime namespace and its policy by name

Tool

realtime_namespace_get

Get a realtime namespace and its policy by name

Get a realtime namespace and its policy by name

Behavior

HTTP
GET /realtime/namespaces/:name

Arguments

NameTypeRequiredDescription
namestringNamespace name

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

Get a realtime namespace and its policy by name.

When to use

Get a realtime namespace and its policy by name

Example

Ask your agent something like this:

Get a realtime namespace and its policy by name.

The agent will invoke realtime_namespace_get with these arguments:

{
  "name": "<name>"
}

Esc

Start typing to search the docs.

navigateselect