Skip to content

Add API key security guidance to documentation #261

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
warengonzaga wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add API key security guidance to documentation #261

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion references/api/api-keys.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,4 +102,19 @@ createClient({
...
//other parameters
});
```
```

## Keeping Your API Key Secure

Your API key is sensitive — treat it like a password. It is tied to your account, controls your rate limits, and all requests made with it are attributed to you.

<Warning>
If your API key is leaked, unauthorized parties could consume your rate limits or make requests on your behalf. Contact us immediately if you suspect your key has been compromised and we will rotate it for you.
</Warning>

**Best practices:**

- **Keep it server-side only** — never expose it in client-side or frontend code. Use a [proxy API](#proxy-api) if calling Relay from the browser.
- **Use environment variables** — store your key in environment variables, not hardcoded in source code.
- **Don't commit it to version control** — add it to `.gitignore` or use a secrets manager.
- **Restrict access** — only share the key with team members who need it.