Welcome to the Rafter API
The Rafter API provides programmatic access to our security scanning capabilities. Use this API to integrate security scanning into your applications, automation workflows, and CI/CD pipelines.Base URL
API Endpoints
Authentication
All API requests require authentication using an API key. Include your API key in thex-api-key header with every request.
Your API key starts with
RF and should be kept secure. Never commit it to version control. Use environment variables or secure secret management systems.Rate Limiting
The API implements rate limiting to ensure fair usage:- Rate Limit: 100 requests per minute per IP address
- Quota: Based on your subscription plan
Response Formats
The API supports multiple response formats:JSON (Default)
All endpoints return JSON responses by default:Markdown (format=md)
Some endpoints support Markdown format for human-readable reports:Error Handling
The API uses standard HTTP status codes:
Error responses include a descriptive message:
Getting Started
Check Usage
Check your API quota and remaining scans.
Trigger Scan
Start a new security scan for your repository.
Get Results
Retrieve scan results and vulnerability reports.
CLI
While you can use the API directly with HTTP requests, we also provide powerful CLI tools.Support
- Documentation: This API reference
- Support: Visit our support page