Back to Portal

API Reference

Complete reference for the ProxGate Licensing API v1.

Authentication

All API requests require authentication via API key.

Include your API key in the request headers using one of these methods:

Authorization: Bearer pk_live_your_api_key

— or —

X-Api-Key: pk_live_your_api_key

Get your API key from Dashboard → API Keys.

Rate Limits

Start

100 req/min

Pro

1,000 req/min

Enterprise

10,000 req/min

License Management

POST
/api/v1/licenses/activate

Activate a license key on a specific device or domain.

{
  "license_key": "XXXX-XXXX-XXXX-XXXX",
  "domain": "example.com",
  "ip_address": "1.2.3.4",
  "device_fingerprint": "hw-abc123",
  "device_name": "Production Server"
}
POST
/api/v1/licenses/validate

Validate a license key and optionally check device activation status.

{
  "license_key": "XXXX-XXXX-XXXX-XXXX",
  "device_fingerprint": "hw-abc123",
  "domain": "example.com"
}
POST
/api/v1/licenses/deactivate

Deactivate a license from a specific device or all devices.

{
  "license_key": "XXXX-XXXX-XXXX-XXXX",
  "device_fingerprint": "hw-abc123"
}

WordPress Integration

POST
/api/v1/wordpress/register

Register a WordPress site with the licensing platform.

{
  "site_url": "https://example.com",
  "site_name": "My WordPress Site",
  "admin_email": "[email protected]",
  "wp_version": "6.4",
  "php_version": "8.2",
  "plugin_version": "1.0.0",
  "license_key": "XXXX-XXXX-XXXX-XXXX"
}
POST
/api/v1/wordpress/heartbeat

Send periodic heartbeat to report site status and check for pending actions.

{
  "site_token": "abc123...",
  "wp_version": "6.4",
  "health_data": { "disk_usage": "45%" }
}
POST
/api/v1/wordpress/pending-actions

Retrieve and acknowledge any pending admin actions for the site.

{
  "site_token": "abc123..."
}

Error Codes

400
Bad Request - Missing or invalid parameters
401
Unauthorized - Invalid or missing API key
403
Forbidden - Insufficient permissions or scope
404
Not Found - Resource does not exist
429
Too Many Requests - Rate limit exceeded
500
Internal Server Error - Please contact support