Welcome to the HackerSavanna API. Our API is designed to be predictable and developer-friendly, using standard HTTP response codes and authentication. Integrate our platform with your existing workflows to automate tasks and streamline your security operations.
All API requests must be authenticated using an API key. You can generate and manage your API keys from your company's settings page.
Include your API key in the `Authorization` header of your requests, using the `Bearer` scheme.
curl "https://api.hackersavanna.com/v1/reports" \
-H "Authorization: Bearer YOUR_API_KEY"
Our API uses rate limiting to ensure fair usage and stability. The standard rate limit is 100 requests per minute.
If you exceed the rate limit, you will receive a `429 Too Many Requests` response. The response headers will indicate when you can retry:
X-RateLimit-Limit The max requests per minute.X-RateLimit-Remaining Requests remaining in the window.X-RateLimit-Reset Time (UTC epoch seconds) of reset.HackerSavanna uses conventional HTTP response codes to indicate the success or failure of an API request. Error responses include a JSON body with a `message` field.
400 Bad Request: The request was malformed.
401 Unauthorized: Your API key is wrong or missing.
403 Forbidden: You don't have permission to access this resource.
404 Not Found: The requested resource could not be found.
429 Too Many Requests: You're being rate limited.
500 Internal Server Error: We had a problem with our server. Try again later.
503 Service Unavailable: We're temporarily offline for maintenance. Please try again later.
Fetch a list of vulnerability reports for your programs.
The number of reports to return. Default: 25, Max: 100.
Filter reports by status (e.g., 'new', 'triaged').
Filter reports by severity (e.g., 'critical', 'high').
null