latestOpenAPI 3.1.02026-08-2211754502.4 KB

76cfbed5eb40

VPN

List VPN servers

Returns the paginated VPN server list together with the ordered server-group representation used by VPN applications. The order of server_groups matches the order configured in VPN Deploy, and the order of each group's servers array matches the configured server order. Only online, enabled servers are included. Configured groups remain present when empty. An Other group is appended only when ungrouped available servers exist.

get/vpn/servers/list

Query parameters

per_pageinteger

Number of records returned in the vpn_systems pagination object. This does not paginate server_groups.

Response

OK

successtrue required