Push devices list

Open in

Use the ably push devices list command to list push device registrations.

Synopsis

ably push devices list [options]

Options

--device-id

Filter registrations by device ID.

--client-id

Filter registrations by client ID.

--state

Filter registrations by state. Options are ACTIVE, FAILING, and FAILED.

--limit

The maximum number of registrations to retrieve. Defaults to 100.

--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 device registrations:

ably push devices list

Filter by state:

ably push devices list --state ACTIVE

List device registrations filtered by client ID:

ably push devices list --client-id client-1

List device registrations with a limit in JSON format:

ably push devices list --limit 50 --json

See also

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