Interface VPNs

All Known Implementing Classes:

VPNsImpl

public interface VPNs

Client interface for managing VPN configurations on Network Edge devices. Provides operations to list, retrieve, and create site-to-site VPN connections.

Provenance. /ne/v1/vpn* is not in the published network-edgev1 spec (1.0.0); these endpoints exist live (GET /ne/v1/vpn answered HTTP 200 on 2026-11-11). Request and response shapes follow the earlier Network Edge API reference and may change without a spec notice.

Author:

ianjones

Method Summary

Modifier and Type	Method	Description
VPNOperator.VPNBuilder	define(String configName)	Returns an instance of VPNBuilder for defining a new VPN.
VPN	getByUuid(String uuid)	Gets the specified VPN.
PaginatedList<VPN>	list()	Lists available VPNs.
PaginatedList<VPN>	list(RequestBuilder.VPN requestBuilder)	Lists VPNs based on the parameters provided.

Method Details

list

PaginatedList<VPN> list()

Lists available VPNs.

Returns:

PaginatedList

list

PaginatedList<VPN> list(RequestBuilder.VPN requestBuilder)

Lists VPNs based on the parameters provided.

Parameters:

requestBuilder - the desired query parameters.

Returns:

PaginatedList

getByUuid

VPN getByUuid(String uuid)

Gets the specified VPN.

Parameters:

uuid - the unique identifier of the VPN.

Returns:

VPN

define

VPNOperator.VPNBuilder define(String configName)

Returns an instance of VPNBuilder for defining a new VPN.

Parameters:

configName - the configuration name of the new VPN.

Returns:

VPNOperator.VPNBuilder