NSX Autonomous Edge REST API

Get IPSec VPN session list result

Get paginated list of all IPSec VPN sessions.

Request:

Method:
GET
URI Path(s):
/vpn/ipsec/sessions
Request Headers:
n/a
Query Parameters:
IPSecVPNSessionListParameters+
Request Body:
n/a

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
IPSecVPNSessionListResult+

Example Response:

{ "_schema": "IPSecVPNSessionListResult", "_self": { "href": "/api/v1/vpn/ipsec/sessions", "rel": "self" }, "result_count": 1, "results": [ { "display_name": "PBS 12", "enabled": true, "id": "df90e18a-08cc-418a-8c0f-259d9531c207", "local_endpoint": { "local_address": "2.2.2.2", "local_id": "2.2.2.2" }, "authentication_mode": "PSK", "connection_initiation_mode": "ON_DEMAND", "peer_address": "4.4.4.1", "peer_id": "4.4.4.1", "policy_rules": [ { "action": "PROTECT", "destinations": [ { "subnet": "2.1.4.0/24" } ], "id": "1026", "sources": [ { "subnet": "1.1.2.0/24" } ] } ], "resource_type": "PolicyBasedIPSecVPNSession" } ] }

Required Permissions:

read

Feature:

vpn

Additional Errors: