Skip to content
Verified

API key hygiene

Full versus custom access, revoking and replacing a key, and spotting one nobody is using.

An API key acts on your account without you: from anywhere, until it is revoked. Authentication covers how a key is created and sent on a call; this page is about keeping the ones you already have honest.

Give a key only what it needs

Every key is Full access or Custom access, chosen when it is created and changeable later from the same form.

  • Full access reaches every method your account can call, including ones added after the key was created. Nothing marked private is ever included, whichever access mode a key has.
  • Custom access reaches only the methods you have explicitly ticked, grouped by microservice with each method's own parameters shown alongside it. A method added later is not covered until you come back and tick it.
Prefer custom access for anything automated

A key wired into a script, a CI job, or a server only needs the handful of methods that job actually calls. Custom access keeps a leaked key from being able to do more than the work it was built for.

Create, reveal and copy

Creating a key needs your account verified to level 2; see Verification. The Create key button explains this and links straight to the next unfinished step if you are not there yet. A newly created key's value is shown once in the Quick copy panel at the top of the list; after that, each row keeps it masked, and a row's own reveal button shows it again for 20 seconds before it re-masks itself.

A key is a secret, not a label

The value is never written to a log, a toast, or the address bar, only ever to your clipboard. Treat it exactly like a password. Anyone who has it can act as your account.

Replace, revoke, and spot one going unused

There is no separate rotate action, because a key's value is its own identifier. Replace creates a new key with the same name and access, revokes the old one, and shows the new value once so you can copy it before closing the dialog. Revoke removes a key outright, and asks you to confirm it by name first, since it cannot be undone.

Each key's row shows when it was last used, drawn from the last 7 days of activity; a key with no line under it simply made no call in that window. That is the row worth a second look.

Replace a key that may have leaked

Open the key, press Replace, and copy the new value the moment it appears. The old value stops working the instant the replace completes.

Revoke a key you no longer need

Press Revoke on its row and confirm it by name. A revoked key drops off the active list; there is no way to bring it back.

Check for one nobody is using

Scan the list for a row with no "Last used" line, especially among Full access keys, and revoke it if you cannot account for it.