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 Tier-0.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}/sessions

Delete IPSec VPN session


Delete IPSec VPN session for a given ipsec vpn
service under Tier-0.
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}

Get IPSec VPN Session


Get IPSec VPN session with senstive data for
a given ipsec vpn service under Tier-0.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}?action=show_sensitive_data

Get IPSec VPN Session


Get IPSec VPN session without sensitive data
for a given ipsec vpn service under Tier-0.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}

Create or patch an IPSec VPN session


Create or patch an IPSec VPN session for
a given ipsec vpn service under Tier-0.
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{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 Tier-0.
Revision is optional for creation and required for update.
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{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/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/peer-config

Get IPSec VPN Session Summary


Summarized view of all tier-0 IPSec VPN sessions for a specified service.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}/summary
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}/summary

Get IPSec VPN sessions list result


Get paginated list of all IPSec VPN sessions
for a given locale service under Tier-0.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions (Deprecated)

Delete IPSec VPN session


Delete IPSec VPN session for a given locale
service under Tier-0.
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id} (Deprecated)

Get IPSec VPN Session


Get IPSec VPN session with senstive data for
a given locale service under Tier-0.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}?action=show_sensitive_data (Deprecated)

Get IPSec VPN Session


Get IPSec VPN session without sensitive data
for a given locale service under Tier-0.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id} (Deprecated)

Create or patch an IPSec VPN session


Create or patch an IPSec VPN session for
a given locale service under Tier-0.
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id} (Deprecated)

Create or fully replace IPSec VPN session


Create or fully replace IPSec VPN session for a given
locale service under Tier-0.
Revision is optional for creation and required for update.
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id} (Deprecated)

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/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/peer-config (Deprecated)

Get IPSec VPN Session Summary


Summarized view of all tier-0 IPSec VPN sessions for a specified service.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/summary (Deprecated)
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/summary (Deprecated)

Get IPSec VPN sessions list result


Get paginated list of all IPSec VPN sessions for a given ipsec vpn
service under Tier-1.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/sessions
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/sessions

Delete IPSec VPN session


Delete IPSec VPN session for a given ipsec-vpn service under Tier-1.
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}

Get IPSec VPN Session


Get IPSec VPN session without sensitive data for a ipsec vpn
service under Tier-1.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}

Get IPSec VPN Session


Get IPSec VPN session with senstive data for a ipsec vpn
service under Tier-1.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}?action=show_sensitive_data
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{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 ipsec vpn
service under Tier-1.
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}

Create or fully replace IPSec VPN session


Create or fully replace IPSec VPN session for a ipsec vpn
service under Tier-1.
Revision is optional for creation and required for update.
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{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/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/peer-config
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/peer-config

Get IPSec VPN Session Summary


Summarized view of all tier-1 IPSec VPN sessions for a specified service.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/summary
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/summary

Get IPSec VPN sessions list result


Get paginated list of all IPSec VPN sessions for a given locale
service under Tier-1.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions (Deprecated)

Delete IPSec VPN session


Delete IPSec VPN session for a given locale service under Tier-1.
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id} (Deprecated)

Get IPSec VPN Session


Get IPSec VPN session with senstive data for a given locale
service under Tier-1.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}?action=show_sensitive_data (Deprecated)

Get IPSec VPN Session


Get IPSec VPN session without sensitive data for a given locale
service under Tier-1.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id} (Deprecated)

Create or patch an IPSec VPN session


Create or patch an IPSec VPN session for a given locale
service under Tier-1.
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id} (Deprecated)

Create or fully replace IPSec VPN session


Create or fully replace IPSec VPN session for a given locale
service under Tier-1.
Revision is optional for creation and required for update.
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id} (Deprecated)

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/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/peer-config (Deprecated)

Get IPSec VPN Session Summary


Summarized view of all tier-1 IPSec VPN sessions for a specified service.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/summary (Deprecated)
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/summary (Deprecated)
Additional Links