Apps rules list

Open in

Use the ably apps rules list command to list all channel rules configured for an Ably application.

Synopsis

ably apps rules list [options]

The app ID to list rules for. Uses the currently selected app if not specified.

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

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

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

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

List all channel rules for the current app:

ably apps rules list

List channel rules for a specific app:

ably apps rules list --app aBcDe1

List all channel rules in JSON format:

ably apps rules list --json

List all channel rules in formatted JSON output:

ably apps rules list --pretty-json

The ably apps channel-rules list command displays:

Property	Description
Rule Count	Total number of channel rules found
Channel Rule ID	The unique identifier for each rule
Persisted	Whether messages are persisted for channels matching this rule
Push Enabled	Whether push notifications are enabled
Authenticated	Whether clients must be authenticated
Persist Last Message	Whether only the last message is persisted
Populate Channel Registry	Whether to populate the channel registry
Batching Enabled	Whether message batching is enabled
Conflation Enabled	Whether message conflation is enabled
TLS Only	Whether TLS is enforced
Created	When the rule was created
Updated	When the rule was last updated