List VPNs
unifi_list_vpnsList UniFi gateway VPN servers, clients, and site-to-site tunnels with configuration details such as kind, enabled state, subnet, port, WAN interface, peers, remote subnets, and DNS.
Instructions
List the gateway's VPN servers (WireGuard, OpenVPN, L2TP), VPN clients and site-to-site VPNs with kind, enabled state, subnet, port, WAN interface, peer and remote subnets and DNS. raw: true shows every field.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "unifi_list_vpns"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| raw | No | Return the full controller objects (large) | |
| site | No | Site name/ID as used in the API (e.g. 'default'). Defaults to the configured site. See unifi_list_sites. | |
| fields | No | Only return these fields per item (dot paths, e.g. uplink.name) | |
| search | No | Case-insensitive substring match on names, MACs, IPs and similar |