NSX Autonomous Edge REST API

VPN

Associated URIs:

API Description API Path

Get IPSec dead peer detection (DPD) profile list result


Get paginated list of all dead peer detection (DPD) profiles.
GET /vpn/ipsec/dpd-profiles

Create dead peer detection (DPD) profile


Create dead peer detection (DPD) profile. Any change in profile affects all sessions consuming this profile.
POST /vpn/ipsec/dpd-profiles

Delete dead peer detection (DPD) profile


Delete dead peer detection (DPD) profile.
DELETE /vpn/ipsec/dpd-profiles/{ipsec-vpn-dpd-profile-id}

Get IPSec dead peer detection (DPD) profile


Get IPSec dead peer detection (DPD) profile.
GET /vpn/ipsec/dpd-profiles/{ipsec-vpn-dpd-profile-id}

Edit IPSec dead peer detection (DPD) profile


Edit IPSec dead peer detection (DPD) profile.
PUT /vpn/ipsec/dpd-profiles/{ipsec-vpn-dpd-profile-id}

List IKE profiles


Get paginated list of all IKE Profiles.
GET /vpn/ipsec/ike-profiles

Create custom internet key exchange (IKE) Profile


Create custom internet key exchange (IKE) Profile. IKE Profile is a reusable profile that captures IKE and phase one negotiation parameters. System will be pre provisioned with system owned non editable default IKE profile and suggested set of profiles that can be used for peering with popular remote peers like AWS VPN. User can create custom profiles as needed. Any change in profile affects all sessions consuming this profile.
POST /vpn/ipsec/ike-profiles

Delete custom IKE Profile


Delete custom IKE Profile. Profile can not be deleted if profile has references to it.
DELETE /vpn/ipsec/ike-profiles/{ipsec-vpn-ike-profile-id}

Get IKE Profile


Get custom IKE Profile, given the particular id.
GET /vpn/ipsec/ike-profiles/{ipsec-vpn-ike-profile-id}

Edit custom IKE Profile


Edit custom IKE Profile. System owned profiles are non editable.
PUT /vpn/ipsec/ike-profiles/{ipsec-vpn-ike-profile-id}

Get IPSec multipath group list result


Get paginated list of all IPSec multipath groups.
GET /vpn/ipsec/multi-path-groups

Create custom IPSec VPN multipath group


Create custom IPSec VPN multipath group.
POST /vpn/ipsec/multi-path-groups

Delete custom IPSec multipath group


Delete custom IPSec multipath group. It cannot be deleted if it is referenced
by any IPSec sessions.
DELETE /vpn/ipsec/multi-path-groups/{ipsec-multi-path-group-id}

Get IPSec multipath group


Get custom IPSec multipath group, given the particular id.
GET /vpn/ipsec/multi-path-groups/{ipsec-multi-path-group-id}

Update custom IPSec multipath group


Update custom IPSec multipath group.
PUT /vpn/ipsec/multi-path-groups/{ipsec-multi-path-group-id}

Get IPSec VPN service


Get IPSec VPN service.
GET /vpn/ipsec/service

Edit IPSec VPN service


Edit IPSec VPN service.
PUT /vpn/ipsec/service

Get IPSec VPN session list result


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

Create new VPN session


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

Delete IPSec VPN session


Delete IPSec VPN session.
DELETE /vpn/ipsec/sessions/{ipsec-vpn-session-id}

Fetch IPSec VPN session


Fetch IPSec VPN session.
GET /vpn/ipsec/sessions/{ipsec-vpn-session-id}

Fetch IPSec VPN session with PSK


Fetch IPSec VPN session with PSK.
GET /vpn/ipsec/sessions/{ipsec-vpn-session-id}?action=show-sensitive-data

Edit IPSec VPN session


Edit IPSec VPN session.
PUT /vpn/ipsec/sessions/{ipsec-vpn-session-id}

Get IPSec VPN session statistics


Get statistics of a vpn session across all tunnels and IKE session.
GET /vpn/ipsec/sessions/{session-id}/statistics

Get IPSecTunnelProfile List Result


Get paginated list of all IPSecTunnelProfiles.
GET /vpn/ipsec/tunnel-profiles

Create custom IPSec tunnel profile


Create custom IPSec tunnel profile. IPSec tunnel profile is a reusable profile that captures phase two negotiation parameters and tunnel properties. System will be provisioned with system owned non editable default IPSec tunnel profile. Any change in profile affects all sessions consuming this profile.
POST /vpn/ipsec/tunnel-profiles

Delete custom IPSecTunnelProfile


Delete custom IPSec Tunnel Profile.
DELETE /vpn/ipsec/tunnel-profiles/{ipsec-vpn-tunnel-profile-id}

Get IPSec tunnel profile


Get custom IPSec Tunnel Profile.
GET /vpn/ipsec/tunnel-profiles/{ipsec-vpn-tunnel-profile-id}

Edit custom IPSecTunnelProfile


Edit custom IPSec Tunnel Profile. System owned profiles are non editable.
PUT /vpn/ipsec/tunnel-profiles/{ipsec-vpn-tunnel-profile-id}