Creating keys
Create keys in the console under API keys. The full key is shown once at creation — copy it then. Inboundr stores only a hash, so a lost key can’t be recovered; revoke it and create a new one. Keys start withinb_. Treat them like passwords: never commit them or expose
them in client-side code.
Scopes
Every key is one of two kinds, chosen when you create it:
Read-only is the default, and it’s the right choice for most keys. An agent that
polls an inbox, a dashboard, a sync job — none of them need to create resources
or change where mail is routed, and a read-only key that leaks can’t do either.
The rule is the HTTP method:
GET and HEAD are reads, everything else is a
write. A read-only key attempting a write gets 403 and the request is not
performed:
POST, the tool decides
instead. create_inbox, create_shield_rule, and delete_shield_rule need
full access; every list_* and get_* tool works with a read-only key.
A key’s scope is fixed once created — there’s no way to widen a read-only key
into a full one, which is the point. Create a second key instead, and revoke
whichever you stop using.
Using a key
Revoking keys
Revoke a key from the console at any time. Revocation is immediate — subsequent requests with that key return401.