Push channels remove-where

Use the ably push channels remove-where command to remove push channel subscriptions matching filter criteria.

Synopsis

ably push channels remove-where <channel-name> [options]

Arguments

channel-name

Required

The channel to remove subscriptions from.

Options

--device-id

Filter subscriptions by device ID.

--client-id

Filter subscriptions by client ID.

--force | -f

Skip confirmation prompt. Required when using --json. The default is false.

--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

Remove all subscriptions on a channel:

ably push channels remove-where "my-channel"

Remove all subscriptions for a device on a channel:

ably push channels remove-where "my-channel" --device-id device-123 --force

Remove all subscriptions for a client on a channel:

ably push channels remove-where "my-channel" --client-id client-1 --force

Remove push subscriptions and output in JSON format:

ably push channels remove-where "my-channel" --json

See also

• Push — Explore all ably push commands.
• CLI reference — Full list of available commands.