NSX-T Data Center REST API

Associated URIs:

API Description API Path

Get IPSec VPN sessions list result


Get paginated list of all IPSec VPN sessions
for a given ipsec vpn service under Transit Gateway.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/transit-gateways/{transit-gateway-id}/ipsec-vpn-services/{ipsec-vpn-service-id}/sessions

Delete IPSec VPN session


Delete IPSec VPN session for a given ipsec vpn
service under Transit Gateway.
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/transit-gateways/{transit-gateway-id}/ipsec-vpn-services/{ipsec-vpn-service-id}/sessions/{session-id}

Get IPSec VPN Session


Get IPSec VPN session without sensitive data
for a given ipsec vpn service under Transit Gateway.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/transit-gateways/{transit-gateway-id}/ipsec-vpn-services/{ipsec-vpn-service-id}/sessions/{session-id}

Get IPSec VPN Session


Get IPSec VPN session with senstive data for
a given ipsec vpn service under Transit Gateway.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/transit-gateways/{transit-gateway-id}/ipsec-vpn-services/{ipsec-vpn-service-id}/sessions/{session-id}?action=show_sensitive_data

Create or patch an IPSec VPN session


Create or patch an IPSec VPN session for
a given ipsec vpn service under Transit Gateway.
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/transit-gateways/{transit-gateway-id}/ipsec-vpn-services/{ipsec-vpn-service-id}/sessions/{session-id}

Create or fully replace IPSec VPN session


Create or fully replace IPSec VPN session for a given
ipsec vpn service under Transit Gateway.
Revision is optional for creation and required for update.
Firewall is not supported on Route Based VPN session.
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/transit-gateways/{transit-gateway-id}/ipsec-vpn-services/{ipsec-vpn-service-id}/sessions/{session-id}

Get IPSec VPN configuration for the peer site


Download IPSec VPN configuration for the peer site. Peer config also
contains PSK; be careful when sharing or storing it.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/transit-gateways/{transit-gateway-id}/ipsec-vpn-services/{ipsec-vpn-service-id}/sessions/{session-id}/peer-config