Management Plane API > Networking > VPN > IPSEC > Sessions

Associated URIs:

API Description API Path

Get IPSec VPN session list result


Get paginated list of all IPSec VPN sessions.
GET /api/v1/vpn/ipsec/sessions

Create new VPN session


Create new VPN session.
POST /api/v1/vpn/ipsec/sessions

Delete IPSec VPN session


Delete IPSec VPN session.
DELETE /api/v1/vpn/ipsec/sessions/<ipsec-vpn-session-id>

Fetch IPSec VPN session


Fetch IPSec VPN session.
GET /api/v1/vpn/ipsec/sessions/<ipsec-vpn-session-id>

Edit IPSec VPN session


Edit IPSec VPN session.
PUT /api/v1/vpn/ipsec/sessions/<ipsec-vpn-session-id>

Get VPN configuration for the peer site


API to download VPN configuration for the peer site. The configuration contains pre-shared key and secret; be careful when sharing or storing it.
GET /api/v1/vpn/ipsec/sessions/<ipsec-vpn-session-id>/peer-config

Get the Realized State of a IPSec VPN Session


Return realized state information of a ipsec vpn session.
Any configuration update that affects the ipsec vpn session can use this API
to get its realized state by passing a request_id returned by the
configuration change operation. e.g. Update configuration of ipsec vpn session,
service, endpoints, profiles, etc.
It will return a service disabled error, if the ipsec vpn service associated
with the session is disabled.
GET /api/v1/vpn/ipsec/sessions/<ipsec-vpn-session-id>/state