Auth keys list

Open in

Use the ably auth keys list command to list all API keys for an app.

Synopsis

ably auth keys list [options]

Options

--app

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

--limit

The maximum number of keys to return. 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 API keys for the current app:

ably auth keys list

List keys for a specific app:

ably auth keys list --app "aBcDeF"

List API keys in JSON format:

ably auth keys list --json

List API keys in formatted JSON output:

ably auth keys list --pretty-json

See also

  • Auth — Explore all ably auth commands.
  • CLI reference — Full list of available commands.