Channels list

Use the ably channels list command to list active channels using the channel enumeration API.

Synopsis

ably channels list [options]

Options

--limit

The maximum number of channels to return. Defaults to 100.

--prefix | -p

Filter channels by a name prefix.

--json

Output results as compact JSON. Mutually exclusive with --pretty-json.

--pretty-json

Output results in formatted JSON. Mutually exclusive with --json.

--verbose | -v

Enable verbose logging. Can be combined with --json or --pretty-json.

Examples

List all active channels:

ably channels list

List channels with a specific prefix:

ably channels list --prefix "chat:"

List channels with a limit:

ably channels list --limit 10

List active channels in JSON format:

ably channels list --json

List active channels in formatted JSON output:

ably channels list --pretty-json

See also

• Channels — Explore all ably channels commands.
• CLI reference — Full list of available commands.