Skip to main content

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

CodeDescription
200Success
400Bad request - Invalid parameters
401Unauthorized - Invalid or missing API key
403Forbidden - Insufficient permissions
404Not found
429Rate limited
500Server error

Rate Limits

  • 100 requests/minute per API key
  • Rate limit headers included in responses:
    • X-RateLimit-Limit
    • X-RateLimit-Remaining
    • X-RateLimit-Reset

Endpoints

EndpointDescription
GET /domainsList all domains
POST /domainsAdd a new domain
GET /domains/:idGet domain details
DELETE /domains/:idDelete a domain
GET /changesList changes
GET /changes/:idGet change details