API keys
Issue, reveal, rotate, and revoke the keys developers use with the CLI and their coding agent.
An API key lets the CLI, the pre-commit hook, and your coding agent act as you. Each developer needs one. A single key works for every repository they can access.
Only the owner of a key ever sees it. An admin issues the key, and the owner reveals it once. After that, Lighthouse keeps only a hash, so nobody can show the key again, including RewareLabs.
Issue a key
Go to Team › API keys and press Issue key.
Fill in the form:
| Field | What to enter |
|---|---|
| Key name | Where it's used, such as Laptop or CI. |
| Owner | The team member who will use it. |
| Monthly credit cap | Optional. The most credits this key can use per month. Can't exceed the team limit. |
| Expires | Never, 30 days, or 90 days. |
Press Issue key. A key issued to yourself is shown right away, so copy it. A key issued to someone else is revealed by them. They get an email asking them to sign in.
Reveal your key
When a key is waiting for you, Team › API keys shows You have a key to reveal.
- Press Reveal once.
- Copy the key and store it somewhere safe, such as a password manager.
- Run
reware-lighthouse loginand paste it.
A key can be revealed only once
If you lose it, ask an admin to rotate it. Rotating gives you a new key to reveal.
Rotate or revoke
Open the key's actions under Team › API keys:
| Action | Effect |
|---|---|
| Rotate key | The current key stops working now. A replacement is created for the owner to reveal. Use this for a lost or leaked key. |
| Revoke key | The key stops working now and can't be restored. |
The list also shows each key's status, Last used, Expires, and the Credits it has used this month.
Troubleshooting
| You see | Do this |
|---|---|
| Ask your team admin to issue you a key. | You don't have a key yet. Ask an admin. |
| The CLI rejects your key | It was rotated, revoked, or has expired. Ask an admin to rotate it, reveal the new key, and run reware-lighthouse login again. |
| This API key has reached its monthly credit cap. | Use another key, or ask an admin to raise this key's cap. |