Policy > Networking > Network Services > VPN > IPSEC > Sessions

Get IPSec VPN Session

Get IPSec VPN session without sensitive data
for a given ipsec vpn service under Tier-0.

Request:

Method:
GET
URI Path(s):
/policy/api/v1/infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/ext_net/ipsec-vpn-services/default/sessions/pbs-1

Successful Response:

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

Example Response:

{ "resource_type": "PolicyBasedIPSecVpnSession", "description": "Policy based vpn session 1", "display_name": "pbs-1", "enabled" : true, "connection_initiation_mode" : "INITIATOR", "authentication_mode" : "PSK", "tunnel_profile_path" : "/infra/ipsec-vpn-tunnel-profiles/custom-tunnel-profile", "dpd_profile_path" : "/infra/ipsec-vpn-dpd-profiles/custom-dpd-profile", "ike_profile_path" : "/infra/ipsec-vpn-ike-profiles/custom-ike-profile", "local_endpoint_path" : "/infra/tier-0s/ext_net/ipsec-vpn-services/default/local-endpoints/default-le", "peer_address" : "2.1.4.1", "peer_id" : "2.1.4.1", "rules" : [ { "resource_type": "IPSecVpnRule", "id": "custom-rule-1", "path": "/infra/tier-0s/ext_net/ipsec-vpn-services/default/sessions/pbs-1/rules/custom-rule-1", "parent_path": "/infra/tier-0s/ext_net/ipsec-vpn-services/default/sessions/pbs-1", "relative_path": "custom-rule-1", "sources": [ { "subnet" : "10.0.2.0/24" }, { "subnet" : "10.0.1.0/24" } ], "destinations" : [ { "subnet" : "10.1.1.0/24" } ], "enabled" : true, "logged" : true, "action": "PROTECT", "_create_user": "admin", "_create_time": 1516385949942, "_last_modified_user": "admin", "_last_modified_time": 1516385949942, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 0 } ], "_create_user": "admin", "_create_time": 1516385949942, "_last_modified_user": "admin", "_last_modified_time": 1516385949942, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision" : 0 }

Required Permissions:

read

Feature:

policy_vpn

Additional Errors: