Sign in

v1

latestOpenAPI 3.0.12026-07-142257126.4 KB
namespaces

Lists namespaces

List the namespaces for the specified application ID.

get/apps/{app_id}/namespaces

Path parameters

app_idstring required

The application ID.

Response

Namespace list

authenticatedboolean

If true, clients will not be permitted to use (including to attach, publish, or subscribe) any channels within this namespace unless they are identified, that is, authenticated using a client ID. See the <a href="https://knowledge.ably.com/authenticated-and-identified-clients">Ably knowledge base</a> for more details.

createdinteger

Unix timestamp representing the date and time of creation of the namespace.

idstring

The namespace or channel name that the channel rule will apply to. For example, if you specify namespace the namespace will be set to namespace and will match with channels namespace:* and namespace.

modifiedinteger

Unix timestamp representing the date and time of last modification of the namespace.

persistLastboolean

If true, the last message published on a channel will be stored for 365 days. You can access the stored message only by using the channel rewind mechanism and attaching with rewind=1. Please note that for each message stored, an additional message is deducted from your monthly allocation.

persistedboolean

If true, all messages on a channel will be stored for 24 hours. You can access stored messages via the History API. Please note that for each message stored, an additional message is deducted from your monthly allocation.

pushEnabledboolean

If true, publishing messages with a push payload in the extras field is permitted and can trigger the delivery of a native push notification to registered devices for the channel.

tlsOnlyboolean

If true, only clients that are connected using TLS will be permitted to subscribe to any channels within this namespace.

Example response

[
  {
    "created": 1602844091815,
    "id": "namespace",
    "modified": 1614679682091
  }
]