API Overview
The Diffy API allows you to programmatically access your monitoring data.
Base URL
https://api.trydiffy.com
Authentication
All API requests require authentication. See Authentication for details.
Response Format
All responses are JSON:
{
"data": { ... },
"meta": {
"timestamp": "2024-01-15T10:30:00Z"
}
}
Error Handling
Errors return appropriate HTTP status codes with details:
{
"error": "Domain not found",
"code": "NOT_FOUND",
"details": {
"domain_id": "abc123"
}
}
Status Codes
| Code | Description |
|---|---|
200 | Success |
400 | Bad request - Invalid parameters |
401 | Unauthorized - Invalid or missing API key |
403 | Forbidden - Insufficient permissions |
404 | Not found |
429 | Rate limited |
500 | Server error |
Rate Limits
- 100 requests/minute per API key
- Rate limit headers included in responses:
X-RateLimit-LimitX-RateLimit-RemainingX-RateLimit-Reset
Endpoints
| Endpoint | Description |
|---|---|
GET /domains | List all domains |
POST /domains | Add a new domain |
GET /domains/:id | Get domain details |
DELETE /domains/:id | Delete a domain |
GET /changes | List changes |
GET /changes/:id | Get change details |