Documentation

Everything you need to integrate and use Sivvy's security platform effectively.

Quick Start Guide

Get up and running with Sivvy in minutes

1. Create Your Account

Sign up for a free Sivvy account to get started with IP allowlist management and website monitoring.

# Visit the registration page
https://dash.sivvy.io/register.php

# Or use our API to create an account
curl -X POST https://api.sivvy.io/v2/register \
  -H "Content-Type: application/json" \
  -d '{"email": "user@example.com", "password": "secure_password"}'

2. Get Your API Key

Generate an API key from your dashboard to start integrating Sivvy with your applications.

# Generate API key via dashboard
1. Login to https://dash.sivvy.io
2. Navigate to Settings > API Keys
3. Click "Generate New API Key"
4. Copy and store securely

Integration Examples

Common integration patterns for popular frameworks

PHP Integration

Protect your PHP application with IP allowlist checking.

Laravel Middleware

Create Laravel middleware for automatic IP protection.

ip();
        
        $response = Http::get("https://api.sivvy.io/v2/check-ip", [
            'key' => $apiKey,
            'ip' => $clientIP
        ]);
        
        if (!$response->json('allowed', false)) {
            abort(403, 'Your IP address is not authorized.');
        }
        
        return $next($request);
    }
}

WordPress Plugin

Protect WordPress admin and login pages with Sivvy.

 403]);
    }
}
add_action('init', 'sivvy_ip_protection');

API Reference

Complete API documentation for developers

Check IP Endpoint

Verify if an IP address is allowed to access your application.

GET https://api.sivvy.io/v2/check-ip

Parameters:

  • key (required) - Your API key
  • ip (required) - IP address to check
  • format (optional) - Response format (json|xml)

Add IP Endpoint

Add an IP address to your allowlist programmatically.

POST https://api.sivvy.io/v2/add-ip

Parameters:

  • key (required) - Your API key
  • ip (required) - IP address to add
  • label (optional) - Label for the IP
  • cidr (optional) - CIDR notation for IP ranges
View Complete API Documentation →

Website Monitoring

Set up uptime monitoring and alerts for your websites

Adding Monitors

Monitor your websites for uptime, response time, and SSL certificate expiration.

  1. Login to your Sivvy dashboard
  2. Navigate to "Website Monitoring"
  3. Click "Add New Monitor"
  4. Enter your website URL
  5. Configure check interval (1-60 minutes)
  6. Set up webhook or email notifications

Webhook Notifications

Receive real-time alerts when your website goes down or comes back online.

{
  "event": "site_down",
  "site_url": "https://example.com",
  "site_id": 123,
  "status_code": 500,
  "response_time": 5000,
  "timestamp": "2025-01-03T10:30:00Z",
  "message": "Site is returning HTTP 500 error"
}

Need Help?

Our team is here to help you get the most out of Sivvy's security platform.

Contact Support View Guides