VynVPN API: Automating Team Management

API Overview

VynVPN provides a full REST API for programmatic management. Automate user provisioning, monitor team connections, and integrate VPN management into your existing tools.

Authentication

All API requests require a Bearer token generated from your admin dashboard:

Authorization: Bearer vyn_live_abc123...

Common Use Cases

Auto-Provisioning New Hires

When someone joins your organisation in your HR system, automatically create their VPN account:

POST /api/v1/users
{
  "email": "new.hire@company.com",
  "team": "engineering",
  "role": "member"
}

Deprovisioning on Offboarding

When someone leaves, revoke their access immediately:

DELETE /api/v1/users/{user_id}

Monitoring Active Connections

Check who's currently connected:

GET /api/v1/connections/active

Usage Reports

Pull usage data for billing or compliance:

GET /api/v1/reports/usage?period=monthly&team=engineering

Webhooks

VynVPN can send real-time notifications to your systems:

• `user.connected` — When a team member connects
• `user.disconnected` — When they disconnect
• `policy.violated` — When someone attempts a blocked action
• `subscription.expiring` — 7 days before renewal

Rate Limits

• 100 requests per minute for management endpoints
• 1000 requests per minute for read-only endpoints
• Webhook deliveries: unlimited

SDKs

We provide official SDKs for:

• TypeScript/JavaScript (npm: `@vynvpn/sdk`)
• Python (pip: `vynvpn`)
• Go (module: `github.com/vynvpn/go-sdk`)

Integration Examples

• **Slack bot** — Notify a channel when users connect/disconnect
• **JIRA** — Auto-provision VPN access when onboarding tickets are resolved
• **Terraform** — Manage VPN policies as infrastructure code