How authentication works
Security check endpoints (POST /email/check and POST /ip/check) use API key authentication only.
| Header | Required | Value |
|---|---|---|
X-API-Key | Yes | Your API key (starts with sec4_) |
Content-Type | Yes | application/json |
Accept | Recommended | application/json |
Where to send the key
All requests go to the same base URL (
https://api.bunny.build/api/v1). The environment or plan is determined by the API key you use.Authentication errors
The API returns HTTP
401 when:- The API key is missing from the header
- The key is invalid
- The key has been revoked
Getting an API key
- Sign in to the BunnyBuild Dashboard
- Complete your profile if prompted
- Create an API token and copy it — it is shown only once
- Store the key in a secure place (e.g. environment variables or a secrets manager)
Security best practices
- Store keys in environment variables or a secrets manager
- Never commit API keys to version control or expose them in client-side code
- BunnyBuild will never ask for your key
- Revoke any key that may have been compromised
Example
Error responses
| Status | Meaning |
|---|---|
| 401 | Missing or invalid API key. Include a valid X-API-Key header. |
| 402 | Quota exceeded. Upgrade your plan or wait for the next period. |
| 403 | Account deactivated. Contact support. |