WireGuard API endpoint does not return tunnel description #705
Description
Describe the bug
The API endpoint /api/v2/vpn/wireguard/tunnels does not return the tunnel description (label/name set in the pfSense UI). Only the internal name (e.g., tun_wg0) is returned. This makes it difficult to identify the correct tunnel when there are multiple WireGuard instances.
To Reproduce
Steps to reproduce the behavior:
1- Create a WireGuard tunnel in pfSense CE and assign it a custom description (e.g., "WG to VPS A").
2- Assign this tunnel to an interface.
3- Call the endpoint /api/v2/vpn/wireguard/tunnels.
4- The response only includes the internal name (e.g., tun_wg0), but not the description.
Expected behavior
The response should include the user-defined description of the tunnel, as shown in the pfSense web UI. This is especially important when managing multiple tunnels via the API.
Screenshots or Response
{
"code": 200,
"status": "ok",
"response_id": "SUCCESS",
"message": "",
"data": [
{
"id": 0,
"name": "tun_wg0",
"enabled": true,
"listenport": "51820",
"publickey": "Af7yon24gIhKxTWSkNXtHj6csqlHVEf+BSiy3PTGFFQ=",
"mtu": 1420,
"addresses": null
}
]
}
pfSense Version & Package Version:
- pfSense Version: 2.7.2 CE
- Package Version: latest available (pfSense-pkg-RESTAPI)
Affected Endpoints:
- URL: /api/v2/vpn/wireguard/tunnels
Additional context
The WireGuard tunnel in question is properly configured, active, and associated with a pfSense interface. The description is visible in the pfSense UI but not returned by the API.