put_vpn_client_config_id
Update VPN server configuration including type, enabled state, port, IP ranges, and protocol-specific options for PPTP, OpenVPN, or IPsec.
Instructions
Update the VPNServerConfig
Error codes: inval, nomem, ioerror, nodev, noent, netdown, exist, busy, none, internal, authentication_failed, auth_failed, resolv_failed, connect_timeout, connect_failed, setup_control_failed, setup_call_failed, protocol, remote_terminated, remote_disconnect
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id__path | Yes | (Path parameter) | |
| id | No | VPN server id | |
| type | No | VPN server type — Values: `pptp`: PPTP VPN server; `openvpn`: OpenVPN server; `ipsec`: IPsec IKEv2 server | |
| enabled | No | is the VPN server enabled | |
| enable_ipv4 | No | enable IPv4 on this server | |
| enable_ipv6 | No | enable IPv4 on this server | |
| port | No | the server port | |
| min_port | No | This field indicate the minimum possible value for port (see ConnectionStatus ipv4_port_range) | |
| max_port | No | This field indicate the maximum possible value for port (see ConnectionStatus ipv4_port_range) | |
| port_ike | No | IPSec ike server port | |
| port_nat | No | IPSec nat server port | |
| conf_pptp | No | only available when type is PPTP | |
| conf_openvpn | No | only available when type is OpenVPN | |
| conf_ipsec | No | only available when type is IPsec | |
| ip_start | No | start of the IP range that will be used to give clients an IP | |
| ip_end | No | end of the IP range that will be used to give clients an IP | |
| ip6_start | No | start of the IPv6 range that will be used to give clients an IPv6 | |
| ip6_end | No | end of the IPv6 range that will be used to give clients an IPv6 |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||