Ably · Schema

namespace_response

Real-TimeWebSocketsPub-SubMessagingStreamingPush NotificationsChatLiveSync

Properties

Name Type Description
authenticated boolean 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. Se
created integer Unix timestamp representing the date and time of creation of the namespace.
modified integer Unix timestamp representing the date and time of last modification of the namespace.
id string 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 `name
persisted boolean 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 y
persistLast boolean 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 th
pushEnabled boolean 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.
batchingEnabled boolean If `true`, channels within this namespace will start batching inbound messages instead of sending them out immediately to subscribers.
batchingPolicy string If `true`, groups multiple incoming messages into a single batch.
batchingInterval integer If `true`, the batching interval, configurable from 20ms to 1s, temporarily holds and aggregates incoming messages. These messages are then combined and delivered as a single batch once the interval e
tlsOnly boolean If `true`, only clients that are connected using TLS will be permitted to subscribe to any channels within this namespace.
exposeTimeserial boolean If `true`, messages received on a channel will contain a unique `timeserial` that can be referenced by later messages for use with message interactions.
View JSON Schema on GitHub

JSON Schema

ably-namespace-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/namespace_response",
  "title": "namespace_response",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "authenticated": {
      "type": "boolean",
      "default": false,
      "description": "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 documentation for <a href=\"https://ably.com/docs/auth/identified-clients\">identified clients</a> for more details.",
      "example": false
    },
    "created": {
      "type": "integer",
      "description": "Unix timestamp representing the date and time of creation of the namespace.",
      "example": 1602844091815
    },
    "modified": {
      "type": "integer",
      "description": "Unix timestamp representing the date and time of last modification of the namespace.",
      "example": 1614679682091
    },
    "id": {
      "type": "string",
      "description": "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`.",
      "example": "namespace"
    },
    "persisted": {
      "type": "boolean",
      "default": false,
      "description": "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.",
      "example": false
    },
    "persistLast": {
      "type": "boolean",
      "default": false,
      "description": "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.",
      "example": false
    },
    "pushEnabled": {
      "type": "boolean",
      "default": false,
      "description": "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.",
      "example": false
    },
    "batchingEnabled": {
      "type": "boolean",
      "default": false,
      "description": "If `true`, channels within this namespace will start batching inbound messages instead of sending them out immediately to subscribers.",
      "example": false
    },
    "batchingPolicy": {
      "type": "string",
      "default": "simple",
      "description": "If `true`, groups multiple incoming messages into a single batch.",
      "example": "simple"
    },
    "batchingInterval": {
      "type": "integer",
      "default": 20,
      "description": "If `true`, the batching interval, configurable from 20ms to 1s, temporarily holds and aggregates incoming messages. These messages are then combined and delivered as a single batch once the interval elapses or a size limit is reached (before the interval elapses).",
      "example": 20
    },
    "tlsOnly": {
      "type": "boolean",
      "default": false,
      "description": "If `true`, only clients that are connected using TLS will be permitted to subscribe to any channels within this namespace.",
      "example": false
    },
    "exposeTimeserial": {
      "type": "boolean",
      "description": "If `true`, messages received on a channel will contain a unique `timeserial` that can be referenced by later messages for use with message interactions."
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/ably-namespace-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.