Setup via API Connection (recommended)
v1.0
·
Updated 2 weeks ago
Setup via API Connection
This is the recommended method. The client connects directly to your GateControl server, registers automatically as a peer and keeps the configuration permanently up to date.
Step 1: Create an API token in GateControl Server
- Open the GateControl Web UI
- Go to Settings, then API & Webhooks
- Under API Tokens, enter a token name (e.g.
Windows Client Marc) - Under Integration, enable the Client App scope
- Click Create Token
- Copy the displayed token (
gc_...) — it is only shown once
Step 2: Configure the client
- Launch the GateControl Client
- Switch to the Settings tab
- Enter the Server URL (e.g.
https://vpn.example.com) - Paste the API Key (the copied
gc_...token) - Click Test Connection — a confirmation appears on success
- Click Save & Register
The client automatically registers as a new peer on the server. The peer ID is saved and the WireGuard configuration is downloaded from the server.
Advantages of API Connection
- Automatic peer registration — no manual setup on the server needed
- Config polling — changes on the server are synced automatically
- Heartbeat — the server sees the client online status and traffic
- No manual maintenance — unlike .conf files or QR codes
Tip: In the GateControl Web UI, the new peer appears under Peers with the Windows PC hostname.