Home
Back to docs
API Keys

Creating and Revoking Keys

Create a key with the scopes you tick, copy it from the one-time dialog, and revoke or delete it when finished; revoke asks for no confirmation.

One list of keys, with a form to make new ones.

The list

Columns: Name, Prefix (the first characters, ak_xxxxxxx…), Scopes (the first three as badges, then "+N"), Status (Active, Revoked or Expired), Last used and Actions.

  • Filter by name (partial match) or status. Filters are kept in the address, so a filtered view can be bookmarked.
  • The list can lag by up to about 20 seconds after a change.
  • Last used is the date of the key's last successful call, or "Never". It is written in the background and shows the date only, so it is a rough guide: a key unused for months is usually one to revoke.

Create a key

  1. Press New key.
  2. Enter a name (required, up to 100 characters) that says what uses it.
  3. Tick the scopes. They are grouped by plugin and show the raw permission keys. You see only permissions you hold, and platform-operation ones are hidden unless you are a superadmin. At least one must be ticked or Create stays disabled.
  4. Optionally pick an expiry date (the picker blocks past dates).
  5. Press Create.

The key appears once in a dialog with a Copy button. The dialog does not close on Escape or a click outside; press Done after you have saved the key somewhere safe.

Revoke and delete

  • Revoke disables the key at once and keeps it listed as Revoked. It asks for no confirmation, so check the name first.
  • Delete removes the row permanently, after a confirmation.

Both are written to the audit trail.

If Create is disabled

  • The plan may not include creating keys: a lock banner shows.
  • You may hold no permission that a key can carry.

Good practice

One key per integration, named for it; the fewest scopes that work; an expiry date; revoke at once if a key may have leaked.

Last updated: