Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Limits

This page lists the main limits for client-visible fields.

Tenant

  • Length: 1..128 bytes
  • Allowed characters: a-z, A-Z, 0-9, _, -, ~, @, .
    • If the tenant is sent empty, it is set by default to ~, because the tenant cannot be absent.

Channel

  • Length: 1..256 bytes
  • Allowed characters: a-z, A-Z, 0-9, _, -, ~, @, ., and for subscription patterns also >, #, * (see Wildcard patterns).

Channel names usually use dot-separated tokens (example: a.b.c).

Token

  • Maximum TTL: 24 hours. The expires_at field in token creation and refresh must not exceed 24 hours from the current server time. Use RefreshToken / PUT /v1/refresh-token to extend periodically.

Payload

  • Max length: 65535 bytes (~64 KB). In WebSocket, each message also carries the tenant name, channel name, and a few bytes for protocol/control, so the actual payload is slightly less than 64 KB. In the Quick protocol, the full 64 KB is available for the payload. The exact overhead may change in future versions.