Developer reference
API keys
Bearer tokens for the CLI and CI, scoped to the role of the account that created them.
Creating one
Account → API keys → create. The full key is shown once, at creation, and never again: only a hash of it is stored, so nobody — including Webcuris — can read it back out of the database.
If you lose a key, revoke it and make another. There is no recovery path, and a system that offered one would be storing the key in a form that could be stolen.
Using one
A key is a bearer token. Send it in the Authorization header, or let the CLI do it by setting WEBCURIS_API_KEY.
Keys are independent of session cookies, so a key keeps working when your browser session expires — and revoking a key does not sign you out.
curl -H "Authorization: Bearer wk_..." https://scan.example.com/api/scansScope, and what a key cannot do
A key carries the role of the account that created it and nothing more. A key made by a non-owner cannot reach owner-only routes, and no key can escalate its own role.
Every use updates the key's last-used timestamp, which is what tells you a key you forgot about is still in something's CI configuration. Revocation takes effect immediately, on the next request.