Auth keys get

Use the ably auth keys get command to get details for a specific API key.

Synopsis

ably auth keys get <key-name-or-value> [options]

Arguments

key-name-or-value

Required

The key name (APP_ID.KEY_ID) or full key value (APP_ID.KEY_ID:KEY_SECRET) to get details for.

Options

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

Get a key by its key name:

ably auth keys get "aBcDeF.gHiJkL"

Get a key by its full key value:

ably auth keys get "aBcDeF.gHiJkL:keySecret"

Get a key and output in JSON format:

ably auth keys get "APP_ID.KEY_ID" --json

See also

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