API Reference
API Authentication
How to authenticate with the CodeWall API.
API keys
All API requests are authenticated with API keys passed as Bearer tokens.
Generating a key
- Go to Settings > API Keys in the platform
- Click Generate Key
- Give the key a descriptive name (e.g., "CI/CD pipeline", "Jira integration")
- Copy the key immediately — it will not be shown again
Using a key
Include the key in the Authorization header of every request:
curl -H "Authorization: Bearer YOUR_API_KEY" \
https://api.codewall.ai/v1/testsKey permissions
API keys inherit the permissions of the user who created them:
| User Role | API Key Can |
|---|---|
| Owner / Admin | Full API access — manage tests, findings, settings |
| Member | Create tests, read findings, manage own resources |
| Viewer | Read-only access to tests and findings |
Revoking a key
- Go to Settings > API Keys
- Click the delete icon next to the key
- The key is immediately invalidated
Error responses
| Status Code | Meaning |
|---|---|
401 Unauthorized | Missing or invalid API key |
403 Forbidden | Valid key but insufficient permissions |
429 Too Many Requests | Rate limit exceeded (see Rate Limits) |