Turn a key off and on¶
A leaked key, a runaway script, a finished project: stop a key and the gateway refuses it within seconds. Suspend it while you look, resume it with the same secret, or revoke it for good. When a key stops for another reason, it says why, in words.
Before you start¶
You hold the key, own its agent, or are an admin over it.
Steps¶
- Open Keys and choose the key.
- Choose:
- Suspend: stops it at once. Resume starts it again with the same secret.
- Revoke: stops it for good. Its history stays in the audit log. This can't be undone; issue a new key if needed.
Check it worked¶
The key's status reads Suspended or Revoked, and its detail says why. The gateway refuses it within seconds; the refused calls are in Request logs.
Why a key stops by itself¶
A key stops at once and works again when the reason goes. Its detail names the reason:
| The key says | What to do |
|---|---|
| Suspended by hand | Resume it |
| Its person is disabled | Enable the person, or hand the key over |
| Its person or agent was deleted | Hand it over or revoke it: Holder deleted: hand over or revoke |
| Its person left the team it acts for | Edit it to act for their new team (same secret) |
| Its agent is suspended | Resume the agent |
| Its agent left the application it acts for | Edit its application, or add the agent back |
| It passed its expiry date (reads Expired) | Issue a new key |
| A budget covering it was reached | It works again when the budget's period starts again, or when someone raises the budget; the key names the budget and until when |
| Unused for the organisation's dormant-key period | Resume it if it's still needed |
A key that can't call any model says Calls nothing beside its status: it works, but what it acts for allows no models.
Good to know¶
- A caller using a stopped key is refused by the gateway with the reason in its error, in its own SDK's format.
- Calls refused because a key was revoked or expired aren't linked to the key; organisation admins and viewers find them in Request logs by status 401.
- To stop every call at once in an incident, organisation admins have Stop AI traffic in the top bar.
Related¶
- Rotate a key
- Set key defaults: suspending keys nobody uses.
- Hand over a key
- Errors and refusals: what a caller gets
- Stop AI traffic: every call at once