v1
latestOpenAPI 3.0.12026-07-142257126.4 KBCreates a namespace
Creates a namespace for the specified application ID.
Path parameters
The application ID.
Request body
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.
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.
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.
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.
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.
If true, only clients that are connected using TLS will be permitted to subscribe to any channels within this namespace.
Example request
{
"id": "namespace"
}Response
Namespace created
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.
Unix timestamp representing the date and time of creation of the namespace.
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.
Unix timestamp representing the date and time of last modification of the namespace.
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.
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.
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.
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
}