API ReferenceΒΆ
Complete reference for all ReputeAPI endpoints.
Base URLΒΆ
AuthenticationΒΆ
All API requests require an API key passed in the X-API-Key header:
Endpoints OverviewΒΆ
Mailflow Security API (Primary)ΒΆ
| Endpoint | Method | Description |
|---|---|---|
/api/v1/check |
GET | Full security check with score and detailed results |
/api/v1/score |
GET | Quick score check (faster, limited details) |
/api/v1/recommendations |
POST | Get prioritized recommendations |
/api/v1/history |
GET | Historical snapshots and trend analysis |
Validation API (Legacy)ΒΆ
| Endpoint | Method | Description |
|---|---|---|
/v1/validate |
GET | Single domain validation |
/v1/validate/bulk |
POST | Bulk domain validation (up to 100) |
Usage & ManagementΒΆ
| Endpoint | Method | Description |
|---|---|---|
/v1/usage |
GET | View API usage statistics |
Rate LimitsΒΆ
Rate limits vary by plan tier:
| Tier | Requests/Month | Requests/Minute |
|---|---|---|
| Free | 1,000 | 10 |
| Basic | 10,000 | 60 |
| Premium | 50,000 | 120 |
When rate limited, you'll receive a 429 Too Many Requests response:
Response FormatsΒΆ
All responses return JSON with appropriate HTTP status codes:
- 200 OK - Request successful
- 400 Bad Request - Invalid parameters
- 401 Unauthorized - Missing or invalid API key
- 404 Not Found - Resource not found
- 429 Too Many Requests - Rate limit exceeded
- 500 Internal Server Error - Server error
Common ParametersΒΆ
Query ParametersΒΆ
domain(string, required) - Domain to validate (e.g.,example.com)selectors(string, optional) - Comma-separated DKIM selectors (e.g.,default,google,s1)verbose(boolean, optional) - Include verbose details (default:false)refresh(boolean, optional) - Bypass cache and fetch fresh data (default:false)
PaginationΒΆ
Endpoints returning lists support pagination:
limit(integer) - Number of results to return (default: 30)offset(integer) - Number of results to skip (default: 0)
Error HandlingΒΆ
All errors follow a consistent format:
{
"error": "Invalid domain",
"message": "The domain 'example' is not valid",
"code": "INVALID_DOMAIN",
"details": {
"domain": "example",
"reason": "Must be a fully qualified domain name"
}
}
Interactive DocumentationΒΆ
Try the API directly in your browser:
- Swagger UI - Interactive API documentation with try-it-out functionality
- ReDoc - Beautiful API reference documentation