Complete API documentation for integrating Sivvy's security platform into your applications.
All API requests require authentication using your API key
Include your API key in all requests using the key parameter.
# Example API request
curl -X GET "https://api.sivvy.io/v2/check-ip?key=YOUR_API_KEY&ip=203.0.113.42"Manage IP addresses and check access permissions
Verify if an IP address is allowed to access your application.
GET /check-ip
| key | required | Your API key |
| ip | required | IP address to check |
| format | optional | Response format (json, xml). Default: json |
{
"allowed": true,
"ip": "203.0.113.42",
"label": "Office Network",
"timestamp": "2025-01-03T10:30:00Z",
"rate_limit": {
"remaining": 98,
"reset": "2025-01-03T11:00:00Z"
}
}Add a new IP address to your allowlist.
POST /add-ip
curl -X POST "https://api.sivvy.io/v2/add-ip" \
-H "Content-Type: application/json" \
-d '{
"key": "YOUR_API_KEY",
"ip": "203.0.113.42",
"label": "Office Network",
"cidr": "203.0.113.0/24"
}'Remove an IP address from your allowlist.
DELETE /remove-ip
curl -X DELETE "https://api.sivvy.io/v2/remove-ip" \
-H "Content-Type: application/json" \
-d '{
"key": "YOUR_API_KEY",
"ip": "203.0.113.42"
}'Add and manage website monitors programmatically
Add a new website to monitor for uptime and performance.
POST /monitors
curl -X POST "https://api.sivvy.io/v2/monitors" \
-H "Content-Type: application/json" \
-d '{
"key": "YOUR_API_KEY",
"url": "https://example.com",
"interval": 300,
"webhook_url": "https://your-app.com/webhook"
}'Retrieve current status and recent checks for a monitor.
GET /monitors/{monitor_id}
{
"id": 123,
"url": "https://example.com",
"status": "up",
"response_time": 245,
"status_code": 200,
"last_check": "2025-01-03T10:30:00Z",
"uptime_24h": 99.5,
"uptime_7d": 99.8,
"ssl_expiry": "2025-12-01T00:00:00Z"
}Understanding API limits and proper error handling
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 998
X-RateLimit-Reset: 1641024000{
"error": {
"code": 401,
"message": "Invalid API key",
"details": "The provided API key is not valid"
}
}Official SDKs and community libraries to integrate Sivvy faster.
Coming Soon
Coming Soon
Coming Soon