API keys
Create, store and revoke the keys your server uses to call the RamenID API.
Create a key
Open API keys → Create key, give it a name (like "Production server") and click Create key. The key is shown once: copy it then. If you lose it, revoke it and create another.
Keys look like rmn_live_ followed by 32 letters and numbers. There are no test keys; every key works against your real workspace and counts toward your plan.
You can have up to 10 active keys.
Store it safely
- Keep it on your server, for example as the
RAMENID_API_KEYenvironment variable. - Never put it in a browser, a mobile app or a public repository. Anyone with the key can create links in your workspace.
- Use one key per environment or service so you can revoke one without affecting the others.
We store only a fingerprint (hash) of each key, plus its first characters so you can tell keys apart. Nobody at RamenID can see your key.
Revoke a key
Click Revoke next to the key and confirm. It stops working immediately; requests with it get 401 unauthorized.
The table shows when each key was created and last used, to help you find keys nobody uses any more.
Keys belong to one workspace
Every request includes your workspace address in the URL. A key only works for its own workspace; using it with another address returns 403 wrong_workspace.