AblyDocs

Auth keys revoke

Open in

Use the ably auth keys revoke command to permanently revoke an API key.

Synopsis

ably auth keys revoke <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) of the API key to revoke.

Options

--force | -f

Skip the confirmation prompt and revoke the key immediately. Required when using --json.

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

Revoke an API key by key name:

ably auth keys revoke "aBcDeF.gHiJkL"

Revoke an API key by full key value:

ably auth keys revoke "aBcDeF.gHiJkL:keySecret"

Force revoke without confirmation:

ably auth keys revoke "aBcDeF.gHiJkL" --force

Revoke a key and output the result in JSON format:

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

See also

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